Skip to main content

Submit Customer KYC

Endpoint : POST https://api.zamp.finance/api/client/:clientid/customer/kyc

Request

Fields Description

KeyTypeDescriptionRequired
first_namestringThe first name of the customer.Yes
last_namestringThe last name of the customer.Yes
emailstringThe email address of the customer.Yes
phone_numberstringThe phone number of the customer.Yes
nationalitystringThe nationality of the customer.Yes
addressAddressThe address details of the customer.Yes
date_of_birthstringThe date of birth of the customer (YYYY-MM-DD).Yes
country_of_birthstringThe country where the customer was born.Yes
country_of_residencestringThe country where the customer is currently reside.Yes
employment_industrystring("Construction", "Gaming", "Construction", "Financial Service", "Information Technology", "Self Employed")Yes
country_of_employmentstringThe country of the customer is currently employed.Yes
selfiestringBase64 of the selfieYes
pep_declarationpep_declarationThis field is used to declare whether the customer is a Politically Exposed Person (PEP) or is closely related to a PEP.Yes
document[]documentDocument of the customerYes
tnc_consenttnc_consentThis information is used for accepting all TnC, fetched from Get TnC APIYes
vendor_detailsvendor_detailsThese details will be used for verification of data provided in aboveNo

KYC Details

Each entry in the Address array is an object with the following fields:

KeyTypeDescriptionRequired
address1stringThe primary address line.Yes
citystringThe city of the address.Yes
countrystringThe country of the address.Yes
statestringThe state of the address.Yes
zip_codestringThe ZIP code of the address.Yes

document

KeyTypeDescriptionRequired
document_typestringDocument TypeYes
document_sub_tyestring"FRONT", "BACK"yes
numberstringDocument numberYes
issued_datestringDocument issued dateYes
place_of_birthstringPlace of birthYes
document_base64stringBase64 of the documentYes
KeyTypeDescriptionRequired
signed_timestampstringThe timestamp when the agreement was signed.Yes
viewed_timestampstringThe timestamp when the agreement was viewed.Yes
end_user_ipstringThe IP address of the end user.Yes

vendor_details

KeyTypeDescriptionRequired
namestringThe name of the customer as per the vendor.No
date_of_birthstringThe date of birth of the customer as per vendor in YYYY-MM-DD format.No
nationalitystringThe nationality of the customer as per vendor.No
kyc_tokenstringThe 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.

KeyTypeDescriptionRequired
is_pepboolIndicates if the individual declares themselves as a Politically Exposed Person (PEP).Yes
pep_detailsobjectDetails about the PEP, required only if is_pep is true.No
pep_details.countrystringThe country where the prominent public function was held.Yes (if is_pep = true)
pep_details.function_rolestringThe specific public function or role held.Yes (if is_pep = true)
is_related_to_pepboolIndicates if the individual is closely related to a PEP.Yes
related_pep_detailsobjectDetails about the related PEP, required only if is_related_to_pep is true.No
related_pep_details.countrystringThe country where the related PEP held their public function.Yes (if is_related_to_pep = true)
related_pep_details.name_of_personstringThe full name of the related PEP.Yes (if is_related_to_pep = true)
related_pep_details.function_rolestringThe 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

KeyTypeDescription
idstringKYC id of the customer
customer_idstringThe unique identifier of the customer.
statusstringThe status of the customer's KYC process.

JSON Response

{
"data": {
"id":"test_id",
"customer_id": "test_id",
"status": "customer kyc status"
}
}