Questions? Feedback? powered by Olark live chat software

API Guide :: Update Customer

Updating customer details

Use this endpoint to modify existing customer's details.

You can freely modify your own customer details. You may also modify the details of customers who are parties in a transaction for which you are the partner, provided that you have been granted the permission to authorise as customers.

Updating customer details by customer ID

Use the customer/me endpoint to update your own customer details, or customer/ID to update a specific customer by ID.

If the API call is successful, it will return the updated customer object.

1
2
3
4
5
6
7
8
curl "https://api.escrow.com/2017-09-01/customer/me" \
    -X PATCH \
    -u "email-address:your-api-key" \
    -H "Content-Type: application/json" \
    -d '
{
  "first_name": "Updated first name"
}'

Example Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
    "display_name": "Updated first name",
    "electronic_verification": {
        "available": false,
        "documents_supported": []
    },
    "email": "customer_email@escrow.com",
    "first_name": "Updated first name",
    "id": 1146621,
    "verification": {
        "company": {
            "status": "not_verified"
        },
        "personal": {
            "status": "not_verified"
        }
    }
}           

Updating a customer's information by Party ID

Use the partner/ID endpoint to update customer details by party.

If the API call is successful, it will return the updated transaction object.

1
2
3
4
5
6
7
8
curl "https://api.escrow.com/2017-09-01/party/2020" \
    -X PATCH \
    -u "email-address:your-api-key" \
    -H "Content-Type: application/json" \
    -d '
{
    "first_name":"Updated first name" 
}'

Example Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
    "display_name": "Updated first name",
    "electronic_verification": {
        "available": false,
        "documents_supported": []
    },
    "email": "customer_email@escrow.com",
    "first_name": "Updated first name",
    "id": 1146621,
    "verification": {
        "company": {
            "status": "not_verified"
        },
        "personal": {
            "status": "not_verified"
        }
    }
}