Developer docs
/
Rebilly API
/
KYC documents
/
Update KYC document matches

Update KYC document matches

Updates the document matches of a KYC document with a specified ID.

Note: Use this operation for manual overrides.

SecurityAPI Key: SecretApiKey or HTTP: JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

Request Body schema: application/json
required

Kyc document resource.

Any of:

Matched identity data.

containsImage
boolean

Specifies if the document includes an image that contains a face.

isIdentityDocument
boolean

Specifies if the document resembles an ID.

isPublishedOnline
boolean

Specifies if an exact match of the document has been found online.

firstName
string or null

First name of the customer. This value is null if no match is found.

lastName
string or null

Last name of the customer. This value is null if no match is found.

dateOfBirth
string or null <date-time>

Date of birth detected on the document. This value is null if no match is detected.

expirationDate
string or null <date-time>

Expiration date detected on the document. This value is null if no expiration date is detected.

issueDate
string or null <date-time>

Issue date detected on the document. This value is null if no issue date is detected.

nationality
string or null <= 3 characters

Nationality detected on a passport or citizenship document. This value is null if no nationality is detected.

issuanceCountry
string or null = 2 characters

Country that issued the document.

issuanceRegion
string or null

Region, state, province, or territory that issued the document.

documentNumber
string or null

Unique number on the identity document. This value may contain alphanumeric characters.

documentSubtype
string or null (KycDocumentSubtypes)

Interpreted subtype of the uploaded document.

Enum: "passport" "id-card" "driver-license" "birth-certificate" "utility-bill" "rental-receipt" "lease-agreement" "copy-credit-card" "credit-card-statement" "bank-statement" "inheritance-documentation" "tax-return" "salary-slip" "sale-of-assets" "public-health-card" "proof-of-age-card" "reverse-of-id" "public-service" "ewallet-holder-details" "ewallet-transaction-statement" "marriage-certificate" "firearms-license" "insurance-letter" "income-statement" "debtors-letter" "other" null
hasMatchingFaceProof
boolean

Specifies if an identity document has matching face proof.

isTampered
boolean

Specifies if an identity document has been tampered with.

expiryDate
string or null <date-time>
Deprecated

Use expirationDate field instead.

post
/kyc-documents/{id}/matches
Request samples
application/json
{
"containsImage": true,
"isIdentityDocument": true,
"isPublishedOnline": false,
"firstName": "John",
"lastName": "Doe",
"dateOfBirth": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"issueDate": "2019-08-24T14:15:22Z",
"nationality": "US",
"issuanceCountry": "CA",
"issuanceRegion": "Ontario",
"documentNumber": "1234567890",
"documentSubtype": "passport",
"hasMatchingFaceProof": false,
"isTampered": false,
"expiryDate": "2019-08-24T14:15:22Z"
}
Responses

204

Document matches updated.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

Response samples
application/json
{
"status": 401,
"type": "http://example.com",
"title": "string",
"detail": "string",
"instance": "string"
}