Update KYC document matches

Request

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

Note: Use this operation for manual overrides.

The request body schema depends on the KYC document documentType. The operation rejects unknown fields.

Send type with one of: identity-proof, address-proof, purchase-proof, or funds-proof. The specified value identifies the type of the document match.

Security
SecretApiKey or JWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required
ID of the resource.
Bodyapplication/jsonrequired
KYC document matches overwrite payload.
typestringrequired

Type of KYC document matches. This value identifies the document match type as identity-proof.

Value:"identity-proof"
Example:"identity-proof"
Discriminator
containsImageboolean
Specifies if the document includes an image that contains a face.
Example:true
isIdentityDocumentboolean
Specifies if the document resembles an ID.
Example:true
isPublishedOnlineboolean
Specifies if an exact match of the document has been found online.
Example:false
firstNamestring or null
First name of the customer. This value is null if no match is found.
Example:"John"
lastNamestring or null
Last name of the customer. This value is null if no match is found.
Example:"Doe"
dateOfBirthstring or null, (date-time)
Date of birth detected on the document. This value is null if no match is detected.
expirationDatestring or null, (date-time)
Expiration date detected on the document. This value is null if no expiration date is detected.
issueDatestring or null, (date-time)
Issue date detected on the document. This value is null if no issue date is detected.
nationalitystring or null, <= 3 characters
Nationality detected on a passport or citizenship document. This value is null if no nationality is detected.
Example:"US"
issuanceCountrystring or null, = 2 characters
Country that issued the document.
Example:"CA"
issuanceRegionstring or null
Region, state, province, or territory that issued the document.
Example:"Ontario"
documentNumberstring or null
Unique number on the identity document. This value may contain alphanumeric characters.
Example:"1234567890"
sexstring or null^[MFX]$

MRZ sex code (ICAO 9303). M, F, or X. Null if not extracted.

Example:"M"
documentSubtypestring 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"
hasMatchingFaceProofboolean
Specifies if an identity document has matching face proof.
Example:false
isTamperedboolean
Specifies if an identity document has been tampered with.
Example:false
isDigitallyTamperedboolean

Specifies if an identity document has been digitally tampered with (experimental).

Example:false
isPhotocopyboolean
Specifies if an identity document is detected as a photocopy.
Example:false
expiryDatestring or null, (date-time)deprecated

Use expirationDate field instead.

curl -i -X POST \
  'https://www.rebilly.com/_mock/catalog/all/kyc-documents/{id}/matches' \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "type": "identity-proof",
    "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",
    "sex": "M",
    "documentSubtype": "passport",
    "hasMatchingFaceProof": false,
    "isTampered": false,
    "isDigitallyTampered": false,
    "isPhotocopy": false,
    "expiryDate": "2019-08-24T14:15:22Z"
  }'

Responses

Document matches updated.
Headers
Rate-Limit-Limitinteger

Maximum number of requests available at one time for this rate limit. For more information, see Rate limits.

Example:500
Rate-Limit-Remaininginteger

Number of requests still available for this rate limit. For more information, see Rate limits.

Example:499
Response
No content