Create a KYC document

Creates a KYC document.

SecurityCustomerJWT
Request
Request Body schema: application/json

KYC document resource.

documentType
required
string

Document type submitted for validation. Only the identity-proof and address-proof types are analyzed automatically.

fileId
string <= 50 characters
Deprecated

ID of the linked file object.

fileIds
Array of strings

IDs of linked file objects.

Uploaded identity-proof files must have the following tags attached to be used for KYC purposes: ['kyc', 'id-front'], ['kyc', 'id-back'], ['kyc', 'face-proof'].

documentSubtype
string

Document subtype submitted for validation.

Enum: "passport" "id-card" "driver-license" "birth-certificate" "utility-bill" "rental-receipt" "lease-agreement" "copy-credit-card" "credit-card-statement" "bank-statement" … 16 more
Responses
201

KYC document created.

Response Headers
Location
string <uri>

Location of the related resource.

Example: "https://api.rebilly.com/example"
Response Schema: application/json
documentType
required
string

Document type submitted for validation. Only the identity-proof and address-proof types are analyzed automatically.

status
required
string

Status of the validation.

Enum: Description
pending

Waiting to be reviewed or analyzed.

in-progress

Being analyzed by the Rebilly AI.

accepted

Accepted by AI or a human.

rejected

Rejected by AI or a human.

archived

Archived by the Rebilly AI.

id
string <= 50 characters

Unique resource ID. Defaults to UUID v4.

fileId
string <= 50 characters
Deprecated

ID of the linked file object.

fileIds
Array of strings

IDs of linked file objects.

Uploaded identity-proof files must have the following tags attached to be used for KYC purposes: ['kyc', 'id-front'], ['kyc', 'id-back'], ['kyc', 'face-proof'].

documentSubtype
string

Document subtype submitted for validation.

Enum: "passport" "id-card" "driver-license" "birth-certificate" "utility-bill" "rental-receipt" "lease-agreement" "copy-credit-card" "credit-card-statement" "bank-statement" … 16 more
object (KycDocumentRejection)

Reason the document is rejected.

type
string (KycDocumentRejectionReasonTypes)

Reason the document is rejected.

Enum: "document-unreadable" "document-expired" "document-not-matching" "document-duplicate" "document-invalid" "document-not-open" "underage-person" "third-party-or-mismatch" "expiration-date-missing" "issue-date-missing" … 5 more
message
string

KYC document rejection message.

requestId
string or null <= 50 characters

ID of the KYC request.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

processedTime
string <date-time>

Date and time when the KYC document is processed.

object

Document matches.

score
number <double>

Calculated score that represents the percentage of confidence that this ID represents the customer.

object (IdentityMatches)

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.

matchingImages
Array of strings <= 3 items

URLs where matching images have 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.

hasMinimalAge
boolean or null

Specifies that the individual is older than the minimal age limit. The minimal age is 21+ the for USA and 18+ for all other countries. This value is null if dateOfBirth is not determined.

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

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" … 16 more
hasMatchingFaceProof
boolean

Specifies if an identity document has matching face proof.

expiryDate
string or null <date-time>
Deprecated

Use expirationDate field instead.

Array of objects (SelfLink)

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

422

Invalid data sent.

post/storefront/kyc-documents
Request samples
application/json
{
  • "fileId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "fileIds": [
    ],
  • "documentType": "identity-proof",
  • "documentSubtype": "passport"
}
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "fileId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "fileIds": [
    ],
  • "documentType": "identity-proof",
  • "documentSubtype": "passport",
  • "status": "pending",
  • "rejectionReason": {
    },
  • "requestId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "processedTime": "2019-08-24T14:15:22Z",
  • "documentMatches": {
    },
  • "_links": [
    ]
}