@bebapps/rapyd-sdk
Version:
An un-official [Rapyd](https://rapyd.net) SDK for Node.js.
183 lines (182 loc) • 6.05 kB
text/typescript
export interface IdentityVerification {
/**
* ID of the identity verification operation. String starting with **kycid_**.
*/
id: `kycid_${string}`;
/**
* Additional data. Response only.
*/
additional_data: string;
/**
* Indicates whether multiple identity checks are allowed for a personal contact.
* - **true** - Enables multiple identity checks.
* - **false** - An identity check is allowed only the first time, or after a previous check resulted in error. This is the default.
*/
allow_multiple_checks: boolean;
/**
* Base-64-encoded image of the back of the ID document. Maximum size: 8,000 pixels height or width, 5 MB.
*/
back_side_image: string;
/**
* MIME type of the front side image of the identification document. One of the following:
* - **image/jpeg** - JPEG image. This is the default.
* - **image/png** - PNG image.
*/
back_side_image_mime_type: string;
/**
* ID of the wallet contact. String starting with **cont_**.
*/
contact: `cont_${string}`;
/**
* The two-letter ISO 3166-1 ALPHA-2 code for the country. Uppercase.
*/
country: string;
/**
* Time of the identity verification operation, in [*Unix time*](ref:glossary). Relevant to webhooks.
*/
created_at: number;
/**
* Date of birth of the individual.
*/
date_of_birth: string;
/**
* Subtype of the identification document.
*/
document_sub_type: string;
/**
* Type of identification document. Two-letter code.
*
* For types that are valid in the country, use [List Official Identification Documents](ref:list-official-identification-documents).
*/
document_type: string;
/**
* ID of the Rapyd Wallet. String starting with **ewallet_**.
*/
ewallet: `ewallet_${string}`;
/**
* ID of the Rapyd Wallet. String starting with **ewallet_**. Relevant to webhooks.
*/
ewallet_id: `ewallet_${string}`;
/**
* Base-64-encoded image of the face. Maximum size: 8,000 pixels height or width, 5 MB.
*/
face_image: string;
/**
* MIME type of the face image. One of the following:
* - **image/jpeg** - JPEG image. This is the default.
* - **image/png** - PNG image.
*/
face_image_mime_type: string;
/**
* Indicates whether face verification was performed.
*/
face_validation: boolean;
/**
* First name of the individual.
*/
first_name: string;
/**
* Base-64-encoded image of the front of the identification document. Maximum size: 8,000 pixels height or width, 5 MB.
*/
front_side_image: string;
/**
* MIME type of the front side image of the identification document. One of the following:
* * **image/jpeg** - JPEG image. This is the default.
* * **image/png** - PNG image.
*/
front_side_image_mime_type: string;
/**
* Gender of the individual. One of the following values:
* * **male**
* * **female**
* **null**
*/
gender: 'male' | 'female';
/**
* ID number as shown on the identification document.
*/
id_number: string;
/**
* Link to the images that were used for this verification.
*/
images: string;
/**
* Indicates whether the person's address can be extracted from the document. Read-only. Relevant to response to [List Official Identification Documents](ref:list-official-identification-documents).
*/
is_address_extractable: boolean;
/**
* Indicates whether the back of the document is required to establish identity. Read-only. Relevant to response to [List Official Identification Documents](ref:list-official-identification-documents).
*/
is_back_required: boolean;
/**
* Last name of the individual.
*/
last_name: string;
/**
* Name of the identification document. One of the following:
* - **Driver's license**
* - **ID card**
* - **Passport**
* Read-only. Relevant to response to [List Official Identification Documents](ref:list-official-identification-documents).
*/
name: 'ID card' | 'Passport';
/**
* End of the time for completing the identity verification process, in [*Unix time*](ref:glossary). Minimum time: 1 day. Default is two weeks from creation of the page.
*/
page_expiration: number;
/**
* ID of the identity verification request. Must be unique for each request. Defined by the client. Maximum length: 36 characters.
*/
reference_id: string;
/**
* Reason for not approving the individual.
*/
reject_reason: string;
/**
* Type of device that supplied the images.
*/
request_source: string;
/**
* Determines the action that is taken on the request. One of the following:
* - **store** - Store the images on the Rapyd platform.
* - **verify** - Verify the identity of the person in the images.
*/
request_type: 'store' | 'verify';
/**
* Determines whether a webhook is sent with the results of the verification request. Default is **true**.
*/
send_callback: boolean;
/**
* State of residence of the individual, as shown on the identification document.
*/
state: string;
/**
* Status of the verified identity. One of the following:
* - **ACT** - The identity verification process is in progress.
* - **CLO** - The identity verification process is closed.
* - **NEW** -The identity verification process has not yet started.
*
* Response only.
*/
status: 'ACT' | 'CLO' | 'NEW';
/**
* Type of identification document. Two-letter code.
*
* For types that are valid in the country, use [List Official Identification Documents](ref:list-official-identification-documents).
*/
type: string;
/**
* Reserved.
*/
valid_countries: string;
/**
* Indicates whether the individual was approved. One of the following:
* - **APPROVED**
* - **NO_DOCUMENT_UPLOADED**
* - **NOT_READABLE_DOCUMENT**
* - **REJECTED**
* - **UNSUPPORTED_COUNTRY**
* - **UNSUPPORTED_TYPE**
*/
verification_status: 'APPROVED' | 'NO_DOCUMENT_UPLOADED' | 'NOT_READABLE_DOCUMENT' | 'REJECTED' | 'UNSUPPORTED_COUNTRY' | 'UNSUPPORTED_TYPE';
};