KYC Documents

Customer KYC files uploaded on behalf of a customer, tagged with a document type and submitted for validation.

Retrieve a list of KYC documents

Retrieve a list of KYC documents.

Authorizations:
query Parameters
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format.

sort
Array of strings

The collection items sort field and order (prefix with "-" for descending sort).

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Responses

Response Headers
Rate-Limit-Limit
integer

The number of allowed requests in the current period.

Rate-Limit-Remaining
integer

The number of remaining requests in the current period.

Rate-Limit-Reset
string

The date in format defined by RFC 822 when the current period will reset.

Pagination-Total
integer

Total items count.

Pagination-Limit
integer

Items per page limit.

Pagination-Offset
integer

Pagination offset.

Response Schema: application/json
Array ()
id
string <= 50 characters

The resource ID. Defaults to UUID v4.

customerId
required
string <= 50 characters

The сustomer's ID.

fileId
string <= 50 characters
Deprecated

Linked file object id.

fileIds
Array of strings

Linked file object id's.

documentType
required
string

Document type submitted for validation, only identity-proof type is analyzed in an automated manner.

documentSubtype
string
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"

Document subtype submitted for validation.

matchLevel
integer [ 1 .. 2 ]

The level of strictness for the document matches.

status
required
string
Enum: "pending" "in-progress" "accepted" "rejected"

Status of the validation.

reason
string

Reason for uploading.

object (KycDocumentRejection)
createdTime
string <date-time>

Creation date/time.

updatedTime
string <date-time>

Latest update date/time.

processedTime
string <date-time>

Processing date/time.

reviewerId
string <= 50 characters Nullable

Reviewer's user ID.

reviewerName
string Nullable

Reviewer's first and last name.

reviewTime
string <date-time> Nullable

Date and time of manual review.

object
object
Array of SelfLink (object) or FileLink (object) or CustomerLink (object) >= 3 items

The links related to resource.

Request samples

// all parameters are optional
const firstCollection = await api.kycDocuments.getAll();

// alternatively you can specify one or more of them
const params = {limit: 20, offset: 100, sort: '-createdTime'};
const secondCollection = await api.kycDocuments.getAll(params);

// access the collection items, each item is a Member
secondCollection.items.forEach(document => console.log(document.fields.documentType));

Response samples

Content type
application/json
[
  • {
    }
]

Create a KYC Document

Create a KYC Document.

Authorizations:
header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Request Body schema: application/json

Kyc document resource.

customerId
required
string <= 50 characters

The сustomer's ID.

fileId
string <= 50 characters
Deprecated

Linked file object id.

fileIds
Array of strings

Linked file object id's.

documentType
required
string

Document type submitted for validation, only identity-proof type is analyzed in an automated manner.

documentSubtype
string
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"

Document subtype submitted for validation.

matchLevel
integer [ 1 .. 2 ]

The level of strictness for the document matches.

reason
string

Reason for uploading.

Responses

Response Headers
Rate-Limit-Limit
integer

The number of allowed requests in the current period.

Rate-Limit-Remaining
integer

The number of remaining requests in the current period.

Rate-Limit-Reset
string

The date in format defined by RFC 822 when the current period will reset.

Response Schema: application/json
id
string <= 50 characters

The resource ID. Defaults to UUID v4.

customerId
required
string <= 50 characters

The сustomer's ID.

fileId
string <= 50 characters
Deprecated

Linked file object id.

fileIds
Array of strings

Linked file object id's.

documentType
required
string

Document type submitted for validation, only identity-proof type is analyzed in an automated manner.

documentSubtype
string
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"

Document subtype submitted for validation.

matchLevel
integer [ 1 .. 2 ]

The level of strictness for the document matches.

status
required
string
Enum: "pending" "in-progress" "accepted" "rejected"

Status of the validation.

reason
string

Reason for uploading.

object (KycDocumentRejection)
createdTime
string <date-time>

Creation date/time.

updatedTime
string <date-time>

Latest update date/time.

processedTime
string <date-time>

Processing date/time.

reviewerId
string <= 50 characters Nullable

Reviewer's user ID.

reviewerName
string Nullable

Reviewer's first and last name.

reviewTime
string <date-time> Nullable

Date and time of manual review.

object
object
Array of SelfLink (object) or FileLink (object) or CustomerLink (object) >= 3 items

The links related to resource.

Request samples

Content type
application/json
Example
{
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "fileId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "fileIds": [
    ],
  • "documentType": "identity-proof",
  • "documentSubtype": "passport",
  • "matchLevel": 2,
  • "reason": "string"
}

Response samples

Content type
application/json
Example
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "fileId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "fileIds": [
    ],
  • "documentType": "identity-proof",
  • "documentSubtype": "passport",
  • "matchLevel": 2,
  • "status": "pending",
  • "reason": "string",
  • "rejectionReason": {
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "processedTime": "2019-08-24T14:15:22Z",
  • "reviewerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "reviewerName": "string",
  • "reviewTime": "2019-08-24T14:15:22Z",
  • "documentMatches": {
    },
  • "parsedData": {
    },
  • "_links": [
    ]
}

Retrieve a KYC Document

Retrieve a KYC document with specified identifier string.

Authorizations:
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Responses

Response Headers
Rate-Limit-Limit
integer

The number of allowed requests in the current period.

Rate-Limit-Remaining
integer

The number of remaining requests in the current period.

Rate-Limit-Reset
string

The date in format defined by RFC 822 when the current period will reset.

Response Schema: application/json
id
string <= 50 characters

The resource ID. Defaults to UUID v4.

customerId
required
string <= 50 characters

The сustomer's ID.

fileId
string <= 50 characters
Deprecated

Linked file object id.

fileIds
Array of strings

Linked file object id's.

documentType
required
string

Document type submitted for validation, only identity-proof type is analyzed in an automated manner.

documentSubtype
string
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"

Document subtype submitted for validation.

matchLevel
integer [ 1 .. 2 ]

The level of strictness for the document matches.

status
required
string
Enum: "pending" "in-progress" "accepted" "rejected"

Status of the validation.

reason
string

Reason for uploading.

object (KycDocumentRejection)
createdTime
string <date-time>

Creation date/time.

updatedTime
string <date-time>

Latest update date/time.

processedTime
string <date-time>

Processing date/time.

reviewerId
string <= 50 characters Nullable

Reviewer's user ID.

reviewerName
string Nullable

Reviewer's first and last name.

reviewTime
string <date-time> Nullable

Date and time of manual review.

object
object
Array of SelfLink (object) or FileLink (object) or CustomerLink (object) >= 3 items

The links related to resource.

Request samples

const document = await api.kycDocuments.get({id: 'foobar-001'});
console.log(document.fields.documentType);

Response samples

Content type
application/json
Example
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "fileId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "fileIds": [
    ],
  • "documentType": "identity-proof",
  • "documentSubtype": "passport",
  • "matchLevel": 2,
  • "status": "pending",
  • "reason": "string",
  • "rejectionReason": {
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "processedTime": "2019-08-24T14:15:22Z",
  • "reviewerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "reviewerName": "string",
  • "reviewTime": "2019-08-24T14:15:22Z",
  • "documentMatches": {
    },
  • "parsedData": {
    },
  • "_links": [
    ]
}

Create or update a KYC document with predefined ID

Create or update a KYC document with predefined identifier string.

Authorizations:
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Request Body schema: application/json

KYC document resource.

customerId
required
string <= 50 characters

The сustomer's ID.

fileId
string <= 50 characters
Deprecated

Linked file object id.

fileIds
Array of strings

Linked file object id's.

documentType
required
string

Document type submitted for validation, only identity-proof type is analyzed in an automated manner.

documentSubtype
string
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"

Document subtype submitted for validation.

matchLevel
integer [ 1 .. 2 ]

The level of strictness for the document matches.

reason
string

Reason for uploading.

Responses

Response Headers
Rate-Limit-Limit
integer

The number of allowed requests in the current period.

Rate-Limit-Remaining
integer

The number of remaining requests in the current period.

Rate-Limit-Reset
string

The date in format defined by RFC 822 when the current period will reset.

Response Schema: application/json
id
string <= 50 characters

The resource ID. Defaults to UUID v4.

customerId
required
string <= 50 characters

The сustomer's ID.

fileId
string <= 50 characters
Deprecated

Linked file object id.

fileIds
Array of strings

Linked file object id's.

documentType
required
string

Document type submitted for validation, only identity-proof type is analyzed in an automated manner.

documentSubtype
string
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"

Document subtype submitted for validation.

matchLevel
integer [ 1 .. 2 ]

The level of strictness for the document matches.

status
required
string
Enum: "pending" "in-progress" "accepted" "rejected"

Status of the validation.

reason
string

Reason for uploading.

object (KycDocumentRejection)
createdTime
string <date-time>

Creation date/time.

updatedTime
string <date-time>

Latest update date/time.

processedTime
string <date-time>

Processing date/time.

reviewerId
string <= 50 characters Nullable

Reviewer's user ID.

reviewerName
string Nullable

Reviewer's first and last name.

reviewTime
string <date-time> Nullable

Date and time of manual review.

object
object
Array of SelfLink (object) or FileLink (object) or CustomerLink (object) >= 3 items

The links related to resource.

Response Headers
Rate-Limit-Limit
integer

The number of allowed requests in the current period.

Rate-Limit-Remaining
integer

The number of remaining requests in the current period.

Rate-Limit-Reset
string

The date in format defined by RFC 822 when the current period will reset.

Response Schema: application/json
id
string <= 50 characters

The resource ID. Defaults to UUID v4.

customerId
required
string <= 50 characters

The сustomer's ID.

fileId
string <= 50 characters
Deprecated

Linked file object id.

fileIds
Array of strings

Linked file object id's.

documentType
required
string

Document type submitted for validation, only identity-proof type is analyzed in an automated manner.

documentSubtype
string
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"

Document subtype submitted for validation.

matchLevel
integer [ 1 .. 2 ]

The level of strictness for the document matches.

status
required
string
Enum: "pending" "in-progress" "accepted" "rejected"

Status of the validation.

reason
string

Reason for uploading.

object (KycDocumentRejection)
createdTime
string <date-time>

Creation date/time.

updatedTime
string <date-time>

Latest update date/time.

processedTime
string <date-time>

Processing date/time.

reviewerId
string <= 50 characters Nullable

Reviewer's user ID.

reviewerName
string Nullable

Reviewer's first and last name.

reviewTime
string <date-time> Nullable

Date and time of manual review.

object
object
Array of SelfLink (object) or FileLink (object) or CustomerLink (object) >= 3 items

The links related to resource.

Request samples

Content type
application/json
Example
{
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "fileId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "fileIds": [
    ],
  • "documentType": "identity-proof",
  • "documentSubtype": "passport",
  • "matchLevel": 2,
  • "reason": "string"
}

Response samples

Content type
application/json
Example
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "fileId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "fileIds": [
    ],
  • "documentType": "identity-proof",
  • "documentSubtype": "passport",
  • "matchLevel": 2,
  • "status": "pending",
  • "reason": "string",
  • "rejectionReason": {
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "processedTime": "2019-08-24T14:15:22Z",
  • "reviewerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "reviewerName": "string",
  • "reviewTime": "2019-08-24T14:15:22Z",
  • "documentMatches": {
    },
  • "parsedData": {
    },
  • "_links": [
    ]
}

Accept a KYC document

Marks that status of the document as accepted. Updates the review time and reviewer information. Intended to be used for manual overrides.

Authorizations:
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Responses

Response Headers
Rate-Limit-Limit
integer

The number of allowed requests in the current period.

Rate-Limit-Remaining
integer

The number of remaining requests in the current period.

Rate-Limit-Reset
string

The date in format defined by RFC 822 when the current period will reset.

Response Schema: application/json
id
string <= 50 characters

The resource ID. Defaults to UUID v4.

customerId
required
string <= 50 characters

The сustomer's ID.

fileId
string <= 50 characters
Deprecated

Linked file object id.

fileIds
Array of strings

Linked file object id's.

documentType
required
string

Document type submitted for validation, only identity-proof type is analyzed in an automated manner.

documentSubtype
string
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"

Document subtype submitted for validation.

matchLevel
integer [ 1 .. 2 ]

The level of strictness for the document matches.

status
required
string
Enum: "pending" "in-progress" "accepted" "rejected"

Status of the validation.

reason
string

Reason for uploading.

object (KycDocumentRejection)
createdTime
string <date-time>

Creation date/time.

updatedTime
string <date-time>

Latest update date/time.

processedTime
string <date-time>

Processing date/time.

reviewerId
string <= 50 characters Nullable

Reviewer's user ID.

reviewerName
string Nullable

Reviewer's first and last name.

reviewTime
string <date-time> Nullable

Date and time of manual review.

object
object
Array of SelfLink (object) or FileLink (object) or CustomerLink (object) >= 3 items

The links related to resource.

Request samples

const acceptedDocument = await api.kycDocuments.accept({id: 'my-second-id'});
console.log(acceptedDocument.fields.status);

Response samples

Content type
application/json
Example
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "fileId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "fileIds": [
    ],
  • "documentType": "identity-proof",
  • "documentSubtype": "passport",
  • "matchLevel": 2,
  • "status": "pending",
  • "reason": "string",
  • "rejectionReason": {
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "processedTime": "2019-08-24T14:15:22Z",
  • "reviewerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "reviewerName": "string",
  • "reviewTime": "2019-08-24T14:15:22Z",
  • "documentMatches": {
    },
  • "parsedData": {
    },
  • "_links": [
    ]
}

Update a KYC document's documentMatches

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

Authorizations:
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

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

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

lastName
string

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

dateOfBirth
string <date-time>

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

expiryDate
string <date-time>

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

issueDate
string <date-time>

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

Responses

Request samples

Content type
application/json
Example
{
  • "containsImage": true,
  • "isIdentityDocument": true,
  • "isPublishedOnline": false,
  • "firstName": "John",
  • "lastName": "Doe",
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "issueDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "status": 400,
  • "title": "string",
  • "detail": "string",
  • "error": "string"
}

Reject a KYC document

Marks that status of the document as rejected. Updates the review time and reviewer information. Intended to be used for manual overrides.

Authorizations:
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Request Body schema: application/json

KYC document resource.

type
string
Enum: "document-unreadable" "document-expired" "document-not-matching" "underage-person" "other"
message
string

The rejection message.

Responses

Response Headers
Rate-Limit-Limit
integer

The number of allowed requests in the current period.

Rate-Limit-Remaining
integer

The number of remaining requests in the current period.

Rate-Limit-Reset
string

The date in format defined by RFC 822 when the current period will reset.

Response Schema: application/json
id
string <= 50 characters

The resource ID. Defaults to UUID v4.

customerId
required
string <= 50 characters

The сustomer's ID.

fileId
string <= 50 characters
Deprecated

Linked file object id.

fileIds
Array of strings

Linked file object id's.

documentType
required
string

Document type submitted for validation, only identity-proof type is analyzed in an automated manner.

documentSubtype
string
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"

Document subtype submitted for validation.

matchLevel
integer [ 1 .. 2 ]

The level of strictness for the document matches.

status
required
string
Enum: "pending" "in-progress" "accepted" "rejected"

Status of the validation.

reason
string

Reason for uploading.

object (KycDocumentRejection)
createdTime
string <date-time>

Creation date/time.

updatedTime
string <date-time>

Latest update date/time.

processedTime
string <date-time>

Processing date/time.

reviewerId
string <= 50 characters Nullable

Reviewer's user ID.

reviewerName
string Nullable

Reviewer's first and last name.

reviewTime
string <date-time> Nullable

Date and time of manual review.

object
object
Array of SelfLink (object) or FileLink (object) or CustomerLink (object) >= 3 items

The links related to resource.

Request samples

Content type
application/json
{
  • "type": "document-unreadable",
  • "message": "Provided document is unreadable"
}

Response samples

Content type
application/json
Example
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "fileId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "fileIds": [
    ],
  • "documentType": "identity-proof",
  • "documentSubtype": "passport",
  • "matchLevel": 2,
  • "status": "pending",
  • "reason": "string",
  • "rejectionReason": {
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "processedTime": "2019-08-24T14:15:22Z",
  • "reviewerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "reviewerName": "string",
  • "reviewTime": "2019-08-24T14:15:22Z",
  • "documentMatches": {
    },
  • "parsedData": {
    },
  • "_links": [
    ]
}

Review a KYC document

Mark the KYC document as reviewed. Updates the review time and reviewer. information.

Authorizations:
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Responses

Response Headers
Rate-Limit-Limit
integer

The number of allowed requests in the current period.

Rate-Limit-Remaining
integer

The number of remaining requests in the current period.

Rate-Limit-Reset
string

The date in format defined by RFC 822 when the current period will reset.

Response Schema: application/json
id
string <= 50 characters

The resource ID. Defaults to UUID v4.

customerId
required
string <= 50 characters

The сustomer's ID.

fileId
string <= 50 characters
Deprecated

Linked file object id.

fileIds
Array of strings

Linked file object id's.

documentType
required
string

Document type submitted for validation, only identity-proof type is analyzed in an automated manner.

documentSubtype
string
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"

Document subtype submitted for validation.

matchLevel
integer [ 1 .. 2 ]

The level of strictness for the document matches.

status
required
string
Enum: "pending" "in-progress" "accepted" "rejected"

Status of the validation.

reason
string

Reason for uploading.

object (KycDocumentRejection)
createdTime
string <date-time>

Creation date/time.

updatedTime
string <date-time>

Latest update date/time.

processedTime
string <date-time>

Processing date/time.

reviewerId
string <= 50 characters Nullable

Reviewer's user ID.

reviewerName
string Nullable

Reviewer's first and last name.

reviewTime
string <date-time> Nullable

Date and time of manual review.

object
object
Array of SelfLink (object) or FileLink (object) or CustomerLink (object) >= 3 items

The links related to resource.

Request samples

const reviewedDocument = await api.kycDocuments.review({id: 'my-second-id'});
console.log(reviewedDocument.fields.status);

Response samples

Content type
application/json
Example
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "fileId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "fileIds": [
    ],
  • "documentType": "identity-proof",
  • "documentSubtype": "passport",
  • "matchLevel": 2,
  • "status": "pending",
  • "reason": "string",
  • "rejectionReason": {
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "processedTime": "2019-08-24T14:15:22Z",
  • "reviewerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "reviewerName": "string",
  • "reviewTime": "2019-08-24T14:15:22Z",
  • "documentMatches": {
    },
  • "parsedData": {
    },
  • "_links": [
    ]
}

KYC document accepted Webhook

Authorizations:
Request Body schema: application/json

KYC document webhook request body resource.

customerId
string

The customer ID.

kycDocumentId
string

The KYC document ID.

fileId
string

The file ID.

eventType
string (GlobalWebhookEventType)
Enum: "aml-list-possibly-matched" "customer-created" "customer-merged" "customer-one-time-password-requested" "customer-updated" "dispute-created" "experian-check-performed" "gateway-account-downtime-ended" "gateway-account-downtime-started" "gateway-account-limit-reached" "gateway-account-requested" "invoice-abandoned" "invoice-created" "invoice-issued" "invoice-modified" "invoice-paid" "invoice-past-due" "invoice-past-due-reminder" "invoice-reissued" "invoice-voided" "kyc-document-accepted" "kyc-document-created" "kyc-document-modified" "kyc-document-rejected" "kyc-document-reviewed" "nsf-response-received" "offsite-payment-completed" "order-completed" "payment-card-created" "payment-card-expiration-reminder" "payment-card-expired" "renewal-invoice-issued" "renewal-invoice-payment-canceled" "renewal-invoice-payment-declined" "risk-score-changed" "subscription-activated" "subscription-canceled" "subscription-modified" "subscription-reactivated" "subscription-renewal-reminder" "subscription-renewed" "subscription-trial-converted" "subscription-trial-end-reminder" "subscription-trial-ended" "subscription-trial-end-changed" "transaction-amount-discrepancy-found" "transaction-declined" "transaction-discrepancy-found" "transaction-process-requested" "transaction-processed" "transaction-reconciled" "transaction-timeout-resolved" "waiting-gateway-transaction-completed"

Rebilly webhooks event type.

object
Array of CustomerLink (object) or FileLink (object) or KycDocumentLink (object) >= 3 items

The links related to resource.

Responses

Request samples

Content type
application/json
{
  • "customerId": "string",
  • "kycDocumentId": "string",
  • "fileId": "string",
  • "eventType": "aml-list-possibly-matched",
  • "_embedded": {
    },
  • "_links": [
    ]
}

KYC document modified Webhook

Authorizations:
Request Body schema: application/json

KYC document webhook request body resource.

customerId
string

The customer ID.

kycDocumentId
string

The KYC document ID.

fileId
string

The file ID.

eventType
string (GlobalWebhookEventType)
Enum: "aml-list-possibly-matched" "customer-created" "customer-merged" "customer-one-time-password-requested" "customer-updated" "dispute-created" "experian-check-performed" "gateway-account-downtime-ended" "gateway-account-downtime-started" "gateway-account-limit-reached" "gateway-account-requested" "invoice-abandoned" "invoice-created" "invoice-issued" "invoice-modified" "invoice-paid" "invoice-past-due" "invoice-past-due-reminder" "invoice-reissued" "invoice-voided" "kyc-document-accepted" "kyc-document-created" "kyc-document-modified" "kyc-document-rejected" "kyc-document-reviewed" "nsf-response-received" "offsite-payment-completed" "order-completed" "payment-card-created" "payment-card-expiration-reminder" "payment-card-expired" "renewal-invoice-issued" "renewal-invoice-payment-canceled" "renewal-invoice-payment-declined" "risk-score-changed" "subscription-activated" "subscription-canceled" "subscription-modified" "subscription-reactivated" "subscription-renewal-reminder" "subscription-renewed" "subscription-trial-converted" "subscription-trial-end-reminder" "subscription-trial-ended" "subscription-trial-end-changed" "transaction-amount-discrepancy-found" "transaction-declined" "transaction-discrepancy-found" "transaction-process-requested" "transaction-processed" "transaction-reconciled" "transaction-timeout-resolved" "waiting-gateway-transaction-completed"

Rebilly webhooks event type.

object
Array of CustomerLink (object) or FileLink (object) or KycDocumentLink (object) >= 3 items

The links related to resource.

Responses

Request samples

Content type
application/json
{
  • "customerId": "string",
  • "kycDocumentId": "string",
  • "fileId": "string",
  • "eventType": "aml-list-possibly-matched",
  • "_embedded": {
    },
  • "_links": [
    ]
}

KYC document rejected Webhook

Authorizations:
Request Body schema: application/json

KYC document webhook request body resource.

customerId
string

The customer ID.

kycDocumentId
string

The KYC document ID.

fileId
string

The file ID.

eventType
string (GlobalWebhookEventType)
Enum: "aml-list-possibly-matched" "customer-created" "customer-merged" "customer-one-time-password-requested" "customer-updated" "dispute-created" "experian-check-performed" "gateway-account-downtime-ended" "gateway-account-downtime-started" "gateway-account-limit-reached" "gateway-account-requested" "invoice-abandoned" "invoice-created" "invoice-issued" "invoice-modified" "invoice-paid" "invoice-past-due" "invoice-past-due-reminder" "invoice-reissued" "invoice-voided" "kyc-document-accepted" "kyc-document-created" "kyc-document-modified" "kyc-document-rejected" "kyc-document-reviewed" "nsf-response-received" "offsite-payment-completed" "order-completed" "payment-card-created" "payment-card-expiration-reminder" "payment-card-expired" "renewal-invoice-issued" "renewal-invoice-payment-canceled" "renewal-invoice-payment-declined" "risk-score-changed" "subscription-activated" "subscription-canceled" "subscription-modified" "subscription-reactivated" "subscription-renewal-reminder" "subscription-renewed" "subscription-trial-converted" "subscription-trial-end-reminder" "subscription-trial-ended" "subscription-trial-end-changed" "transaction-amount-discrepancy-found" "transaction-declined" "transaction-discrepancy-found" "transaction-process-requested" "transaction-processed" "transaction-reconciled" "transaction-timeout-resolved" "waiting-gateway-transaction-completed"

Rebilly webhooks event type.

object
Array of CustomerLink (object) or FileLink (object) or KycDocumentLink (object) >= 3 items

The links related to resource.

Responses

Request samples

Content type
application/json
{
  • "customerId": "string",
  • "kycDocumentId": "string",
  • "fileId": "string",
  • "eventType": "aml-list-possibly-matched",
  • "_embedded": {
    },
  • "_links": [
    ]
}

KYC document reviewed Webhook

Authorizations:
Request Body schema: application/json

KYC document webhook request body resource.

customerId
string

The customer ID.

kycDocumentId
string

The KYC document ID.

fileId
string

The file ID.

eventType
string (GlobalWebhookEventType)
Enum: "aml-list-possibly-matched" "customer-created" "customer-merged" "customer-one-time-password-requested" "customer-updated" "dispute-created" "experian-check-performed" "gateway-account-downtime-ended" "gateway-account-downtime-started" "gateway-account-limit-reached" "gateway-account-requested" "invoice-abandoned" "invoice-created" "invoice-issued" "invoice-modified" "invoice-paid" "invoice-past-due" "invoice-past-due-reminder" "invoice-reissued" "invoice-voided" "kyc-document-accepted" "kyc-document-created" "kyc-document-modified" "kyc-document-rejected" "kyc-document-reviewed" "nsf-response-received" "offsite-payment-completed" "order-completed" "payment-card-created" "payment-card-expiration-reminder" "payment-card-expired" "renewal-invoice-issued" "renewal-invoice-payment-canceled" "renewal-invoice-payment-declined" "risk-score-changed" "subscription-activated" "subscription-canceled" "subscription-modified" "subscription-reactivated" "subscription-renewal-reminder" "subscription-renewed" "subscription-trial-converted" "subscription-trial-end-reminder" "subscription-trial-ended" "subscription-trial-end-changed" "transaction-amount-discrepancy-found" "transaction-declined" "transaction-discrepancy-found" "transaction-process-requested" "transaction-processed" "transaction-reconciled" "transaction-timeout-resolved" "waiting-gateway-transaction-completed"

Rebilly webhooks event type.

object
Array of CustomerLink (object) or FileLink (object) or KycDocumentLink (object) >= 3 items

The links related to resource.

Responses

Request samples

Content type
application/json
{
  • "customerId": "string",
  • "kycDocumentId": "string",
  • "fileId": "string",
  • "eventType": "aml-list-possibly-matched",
  • "_embedded": {
    },
  • "_links": [
    ]
}