Submit Customer KYC
Endpoint : POST https://api.zamp.finance/api/client/:clientid/customer/kyc
Request
Fields Description
Key | Type | Description | Required |
---|---|---|---|
first_name | string | The first name of the customer. | Yes |
last_name | string | The last name of the customer. | Yes |
string | The email address of the customer. | Yes | |
phone_number | string | The phone number of the customer. | Yes |
nationality | string | The nationality of the customer. | Yes |
address | Address | The address details of the customer. | Yes |
date_of_birth | string | The date of birth of the customer (YYYY-MM-DD). | Yes |
country_of_birth | string | The country where the customer was born. | Yes |
country_of_residence | string | The country where the customer is currently reside. | Yes |
employment_industry | string | ("Construction", "Gaming", "Construction", "Financial Service", "Information Technology", "Self Employed") | Yes |
country_of_employment | string | The country of the customer is currently employed. | Yes |
selfie | string | Base64 of the selfie | Yes |
pep_declaration | pep_declaration | This field is used to declare whether the customer is a Politically Exposed Person (PEP) or is closely related to a PEP. | Yes |
document | []document | Document of the customer | Yes |
tnc_consent | tnc_consent | This information is used for accepting all TnC, fetched from Get TnC API | Yes |
vendor_details | vendor_details | These details will be used for verification of data provided in above | No |
KYC Details
Each entry in the Address
array is an object with the following fields:
Key | Type | Description | Required |
---|---|---|---|
address1 | string | The primary address line. | Yes |
city | string | The city of the address. | Yes |
country | string | The country of the address. | Yes |
state | string | The state of the address. | Yes |
zip_code | string | The ZIP code of the address. | Yes |
document
Key | Type | Description | Required |
---|---|---|---|
document_type | string | Document Type | Yes |
document_sub_tye | string | "FRONT", "BACK" | yes |
number | string | Document number | Yes |
issued_date | string | Document issued date | Yes |
place_of_birth | string | Place of birth | Yes |
document_base64 | string | Base64 of the document | Yes |
tnc_consent
Key | Type | Description | Required |
---|---|---|---|
signed_timestamp | string | The timestamp when the agreement was signed. | Yes |
viewed_timestamp | string | The timestamp when the agreement was viewed. | Yes |
end_user_ip | string | The IP address of the end user. | Yes |
vendor_details
Key | Type | Description | Required |
---|---|---|---|
name | string | The name of the customer as per the vendor. | No |
date_of_birth | string | The date of birth of the customer as per vendor in YYYY-MM-DD format. | No |
nationality | string | The nationality of the customer as per vendor. | No |
kyc_token | string | The KYC token associated with the customer as per vendor. | No |
pep_declaration
This field is used to declare whether the customer is a Politically Exposed Person (PEP) or is closely related to a PEP.
Key | Type | Description | Required |
---|---|---|---|
is_pep | bool | Indicates if the individual declares themselves as a Politically Exposed Person (PEP). | Yes |
pep_details | object | Details about the PEP, required only if is_pep is true . | No |
pep_details.country | string | The country where the prominent public function was held. | Yes (if is_pep = true) |
pep_details.function_role | string | The specific public function or role held. | Yes (if is_pep = true) |
is_related_to_pep | bool | Indicates if the individual is closely related to a PEP. | Yes |
related_pep_details | object | Details about the related PEP, required only if is_related_to_pep is true . | No |
related_pep_details.country | string | The country where the related PEP held their public function. | Yes (if is_related_to_pep = true) |
related_pep_details.name_of_person | string | The full name of the related PEP. | Yes (if is_related_to_pep = true) |
related_pep_details.function_role | string | The specific public function or role held by the related PEP. | Yes (if is_related_to_pep = true) |
Example JSON Request
{
"first_name": "jhon",
"last_name": "doe",
"email": "[email protected]",
"phone_number": "+91919191991",
"nationality": "US",
"address": {
"address1": "test",
"city": "test",
"country": "US",
"state": "Ohio",
"zip_code": "43057"
},
"date_of_birth": "1999-12-12",
"country_of_birth": "AE",
"country_of_residence": "AE",
"employment_industry": "Self Employed",
"country_of_employment": "AE",
"pep_declaration": {
"is_pep": true,
"pep_details": {
"country": "AE",
"function_role": "Function or Role"
},
"is_related_to_pep": false,
"related_pep_details": {}
},
"document": [
{
"document_type": "passport",
"document_sub_type": "FRONT",
"number": "1234",
"issued_date": "2012-09-09",
"place_of_birth": "India",
"document_base64": "Base64 of of the document"
},
{
"document_type": "passport",
"document_sub_type": "BACK",
"document_base64": "Base64 of of the document"
}
],
"selfie": "Base64 of the selfie",
"tnc_consent": {
"signed_timestamp": "2023-01-17T09:19:13.619Z",
"viewed_timestamp": "2023-01-17T09:16:10.619Z",
"end_user_ip": "14.97.236.202"
},
"vendor_details": {
"name": "jhon doe",
"date_of_birth": "1999-12-12",
"nationality": "UAE",
"kyc_token": "kyc_token_of_vendor"
}
}
Response
Key | Type | Description |
---|---|---|
id | string | KYC id of the customer |
customer_id | string | The unique identifier of the customer. |
status | string | The status of the customer's KYC process. |
JSON Response
{
"data": {
"id":"test_id",
"customer_id": "test_id",
"status": "customer kyc status"
}
}