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}}`

Updatable fields for send user (individual)

Fields

User is verified

User is not verified

Additional details

first_name

Yes

middle_name

Yes

last_name

Yes

mobile_phone

Yes

address_line1

Yes

address_line2

Yes

city

Yes

state

Yes

country

zipcode

Yes

date_of_birth

Yes

gender

Yes

user_scope

Yes

occupation

Yes

type

physical_documents

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

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":"norgay@test.com",
  "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": "norgay@test.com",
    "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": "example@mail.com",
    "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"
}

PreviousRegister a User NextBusiness Representatives

Last updated 2 years ago

Was this helpful?

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":"norgay@test.com", "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" } ] }'

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" } ] }'

{ "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": "norgay@test.com", "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" }

{ "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": "example@mail.com", "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" }