PaaS API Docs
Search
K
Comment on page

Update User

Read on collecting KYC information and running KYC checks on SEND users
This 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 multiple times as required. Details on what fields can be updated when a user is verified and not verified are provided below.

PATCH /users/{{user_id}}

Individual
Business
Request Sample
Response Sample
Updatable fields for send user (individual)
Fields
User is verified
User is not verified
Additional details
first_name
No
Yes
middle_name
No
Yes
last_name
No
Yes
mobile_phone
Yes
Yes
email
No
Yes
address_line1
Yes
Yes
address_line2
Yes
Yes
city
Yes
Yes
state
Yes
Yes
country
No
No
zipcode
Yes
Yes
date_of_birth
No
Yes
gender
No
Yes
user_scope
No
Yes
occupation
Yes
Yes
type
No
No
physical_documents
Yes
Yes
Updating physical_document object will add a new copy of the document and archive the older one.
virtual_documents
Conditional
Yes
SSN is not updatable once user is verified.
company_details
Yes
Yes
Updatable fields for send user (business)
Fields
User is verified
User is not verified
Additional details
first_name
No
Yes
mobile_phone
Yes
Yes
email
Yes
Yes
address_line1
Yes
Yes
address_line2
Yes
Yes
city
Yes
Yes
state
Yes
Yes
country
No
No
zipcode
Yes
Yes
date_of_birth
No
Yes
business
No
No
business_type
No
Yes
user_scope
No
Yes
company_website
Yes
Yes
number_of_employee
Yes
Yes
mailing_address (address_line1, address_line2, city, state, country, zipcode)
Yes
Yes
virtual_documents
No
Yes
physical_documents
Conditional
Yes
Physical documents of type EIN and CERTIFICATION_OF_INCORPORATION cannot be updated once user is verified.
user_relationship
No
No
number_of_transaction_per_month
Yes
Yes
transaction_frequency
Yes
Yes
Individual User
curl --location -g --request PATCH '{{url}}/users/{{user_id}}' \
--header 'X-Client-Id: {{client_id}}' \
--header 'X-Client-Secret: {{client_secret}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"first_name":"Tenzin",
"middle_name":"",
"last_name":"Norgay",
"date_of_birth":"2000-01-01",
"email":"[email protected]",
"gender":"female",
"id":"f45680e1-014d-42c7-be86-3b2899e911c3",
"ip_address":"10.0.0.1",
"mobile_phone":"2106603032",
"address_line1":"500 8 El Camino Real Santa Clara",
"city":"Santa Clara",
"state":"CA",
"country":"US",
"zipcode":"95053",
"occupation":"Banker",
"company_details":{
"company_name":"ACME",
"address":"123 address st",
"phone_number":"222222222"
},
"physical_documents":[
{
"document_value":"data:image/jpg;base64,SUQs==",
"document_value_back":"data:image/jpg;base64,SUQs==",
"country":"US",
"document_type":"DRIVING_LICENCE",
"state":"CA"
},
{
"document_value":"data:image/jpg;base64,SUQs==",
"document_type":"BANK_STATEMENT",
}
],
"virtual_documents":[
{
"document_value":"1111111111",
"document_type":"DRIVING_LICENCE",
"expiry_date":"2025-03-09",
"id_issuing_authority":"CA",
"country":"US",
"state":"CA"
},
{
"document_value":"111111112",
"document_type":"SSN",
"country":"US",
"state":"CA"
}
]
}'
Business User
curl --location -g --request PATCH '{{url}}/users/{{user_id}}' \
--header 'X-Client-Id: {{client_id}}' \
--header 'X-Client-Secret: {{client_secret}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"number_of_transaction_per_month": "122",
"transaction_frequency": "WEEKLY",
"physical_documents": [
{
"document_value": "data:application/pdf;base64,SUQs==",
"document_type": "CERTIFICATE_OF_INCORPORATION"
},
{
"document_value":"data:image/jpg;base64,SUQs==",
"document_type":"AUDITED_FINANCIALS"
}
]
}'
Individual User
{
"address_line1": "500 8 El Camino Real Santa Clara",
"city": "Santa Clara",
"company_details": {
"address": "123 address st",
"company_name": "ACME",
"phone_number": "222222222"
},
"country": "US",
"created_at": "2022-03-29T15:59:03.699517",
"date_of_birth": "2000-01-01",
"email": "[email protected]",
"first_name": "Tenzin",
"gender": "female",
"id": "f45680e1-014d-42c7-be86-3b2899e911c3",
"ip_address": "10.0.0.1",
"last_name": "Norgay",
"middle_name": "",
"mobile_phone": "2106603032",
"occupation": "Banker",
"physical_documents": [
{
"country": "US",
"document_type": "DRIVING_LICENCE",
"id": "d20dd857-7dc0-4abc-879f-fcfb15f4423d",
"state": "CA"
},
{
"document_type": "BANK_STATEMENT",
"id": "9f57c7c9-ffa5-4e88-a28a-af3af1232a46"
}
],
"state": "CA",
"status": "UNVERIFIED",
"user_scope": "ARTS_ENTERTAINMENT",
"virtual_documents": [
{
"country": "US",
"document_type": "DRIVING_LICENCE",
"document_value": "1111111111",
"id": "38f41ac7-ddb6-44e4-b40c-fa0cf8d05b9d",
"state": "CA",
"expiry_date": "2025-03-09",
"id_issuing_authority": "CA"
},
{
"country": "US",
"document_type": "SSN",
"document_value": "*****1112",
"id": "a301b04f-c904-4c78-9a8b-9a384c51b497",
"state": "CA"
}
],
"zipcode": "95053"
}
Business User
{
"address_line1": "500 8 El Camino Real Santa Clara",
"city": "Santa Clara",
"company_website": "www.example.com",
"country": "US",
"created_at": "2022-04-22T02:21:23.084565",
"date_of_birth": "1995-01-01",
"email": "[email protected]",
"first_name": "Machnet Technologies Inc",
"id": {{UUID}},
"ip_address": "10.0.10.5",
"mailing_address": {
"address_line1": "500 8 El Camino Real Santa Clara",
"city": "Santa Clara",
"country": "US",
"state": "CA",
"zipcode": "95053"
},
"mobile_phone": "222222222",
"number_of_employee": "BETWEEN_25_TO_50",
"number_of_transaction_per_month": 122,
"physical_documents": [
{
"document_type": "CERTIFICATE_OF_INCORPORATION",
"id": {{UUID}}
},
{
"document_type": "BANK_STATEMENT",
"id": {{UUID}}
}
],
"state": "CA",
"status": "UNVERIFIED",
"transaction_frequency": "WEEKLY",
"user_scope": "COMPUTER_TECHNOLOGY",
"zipcode": "95053"
}