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"

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"

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

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
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": {
    },
  • "_links": [
    ]
}