KYC
Read on collecting KYC information and running KYC checks on SEND users

Update KYC Information

The API allows you to update the user information. You can provide all the required user information at once. You can also update the user information partially by using this API with PATCH multiple times as required.

PATCH /users/{{user_id}}

Request Sample
Response Sample
1
curl --location -g --request PATCH '{{url}}/users/{{user_id}}' \
2
--header 'X-Client-Id: {{client_id}}' \
3
--header 'X-Client-Secret: {{client_secret}}' \
4
--header 'Content-Type: application/json' \
5
--data-raw '{
6
"first_name":"Tenzin",
7
"middle_name":"",
8
"last_name":"Norgay",
9
"date_of_birth":"2000-01-01",
10
"email":"[email protected]",
11
"gender":"female",
12
"id":"f45680e1-014d-42c7-be86-3b2899e911c3",
13
"ip_address":"10.0.0.1",
14
"mobile_phone":"2106603032",
15
"address_line1":"500 8 El Camino Real Santa Clara",
16
"city":"Santa Clara",
17
"state":"CA",
18
"country":"US",
19
"zipcode":"95053",
20
"occupation":"Banker",
21
"company_details":{
22
"company_name":"ACME",
23
"address":"123 address st",
24
"phone_number":"222222222"
25
},
26
"physical_documents":[
27
{
28
"document_value":"data:image/jpg;base64,SUQs==",
29
"document_value_back":"data:image/jpg;base64,SUQs==",
30
"country":"US",
31
"document_type":"DRIVING_LICENCE",
32
"state":"CA"
33
},
34
{
35
"document_value":"data:image/jpg;base64,SUQs==",
36
"document_type":"BANK_STATEMENT",
37
}
38
],
39
"virtual_documents":[
40
{
41
"document_value":"1111111111",
42
"document_type":"DRIVING_LICENCE",
43
"expiry_date":"2025-03-09",
44
"id_issuing_authority":"CA",
45
"country":"US",
46
"state":"CA"
47
},
48
{
49
"document_value":"111111112",
50
"document_type":"SSN",
51
"country":"US",
52
"state":"CA"
53
}
54
]
55
}'
Copied!
1
{
2
"address_line1": "500 8 El Camino Real Santa Clara",
3
"city": "Santa Clara",
4
"company_details": {
5
"address": "123 address st",
6
"company_name": "ACME",
7
"phone_number": "222222222"
8
},
9
"country": "US",
10
"created_at": "2022-03-29T15:59:03.699517",
11
"date_of_birth": "2000-01-01",
12
"email": "[email protected]",
13
"first_name": "Tenzin",
14
"gender": "female",
15
"id": "f45680e1-014d-42c7-be86-3b2899e911c3",
16
"ip_address": "10.0.0.1",
17
"last_name": "Norgay",
18
"middle_name": "",
19
"mobile_phone": "2106603032",
20
"occupation": "Banker",
21
"physical_documents": [
22
{
23
"country": "US",
24
"document_type": "DRIVING_LICENCE",
25
"id": "d20dd857-7dc0-4abc-879f-fcfb15f4423d",
26
"state": "CA"
27
},
28
{
29
"document_type": "BANK_STATEMENT",
30
"id": "9f57c7c9-ffa5-4e88-a28a-af3af1232a46"
31
}
32
],
33
"state": "CA",
34
"status": "UNVERIFIED",
35
"user_scope": "ARTS_ENTERTAINMENT",
36
"virtual_documents": [
37
{
38
"country": "US",
39
"document_type": "DRIVING_LICENCE",
40
"document_value": "1111111111",
41
"id": "38f41ac7-ddb6-44e4-b40c-fa0cf8d05b9d",
42
"state": "CA",
43
"expiry_date": "2025-03-09",
44
"id_issuing_authority": "CA"
45
},
46
{
47
"country": "US",
48
"document_type": "SSN",
49
"document_value": "*****1112",
50
"id": "a301b04f-c904-4c78-9a8b-9a384c51b497",
51
"state": "CA"
52
}
53
],
54
"zipcode": "95053"
55
}
Copied!

Initiate KYC

This enables you to initiate the user's KYC process. All required user information needs to be provided before initiating user's KYC.

POST /users/{{user_id}}/kyc

Request Sample
Response Sample
1
curl --location -g --request POST '{{url}}/users/{{user_id}}/kyc' \
2
--header 'X-Client-Id: {{client_id}}' \
3
--header 'X-Client-Secret: {{client_secret}}' \
4
--header 'Content-Type: application/json'
Copied!
1
{
2
"success": true,
3
"status": "INITIATED"
4
}
Copied!
The status of the user changes from "UNVERIFIED" at the beginning to "IN PROGRESS" to "VERIFIED" eventually if the KYC process is complete and successful.