Update a KYC document's documentMatches

Updates a KYC document's documentMatches. Intended to be used for manual overrides.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

Resource identifier string.

Request Body schema: application/json

Kyc document resource.

Any of:
containsImage
boolean

Flag that indicates if there is an image that contains a face on it.

isIdentityDocument
boolean

Flag that indicates if this looks like and ID.

isPublishedOnline
boolean

If there is an exact match found online.

firstName
string or null

The customer first name if it was matched, null otherwise.

lastName
string or null

The customer last name if it was matched, null otherwise.

dateOfBirth
string or null <date-time>

The date of birth found on the document, null if not found.

expirationDate
string or null <date-time>

Expiration date detected on the document. If an expiration date is not detected, this value is null.

issueDate
string or null <date-time>

The issued date found on the document, null if not found.

nationality
string or null <= 3 characters

Nationality detected on a passport or citizenship document. If a nationality is not detected, this value is null.

issuanceCountry
string or null = 2 characters

Country where the document was issued.

issuanceRegion
string or null

Region, state, province, or territory where the document was issued.

documentNumber
string or null

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

documentSubtype
string or null

The interpreted subtype of the uploaded document.

expiryDate
string or null <date-time>
Deprecated

Expiry date detected on the document. If an expiry date is not detected, this value is null.

Responses
204

KYC document's documentMatches were updated.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

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",
  • "expiryDate": "2019-08-24T14:15:22Z"
}
Response samples
application/json
{
  • "status": 401,
  • "title": "string",
  • "detail": "string",
  • "instance": "string"
}