Questions? Feedback? powered by Olark live chat software

API Guide :: Creating a new customer

Creating a new customer on Escrow.com

Creating a new customer on Escrow.com is quite straight forward. The minimal amount of information required is the customers email address. Specifying the customers name, address, phone number and disbursement methods are optional. However within the address and disbursement methods, there are required fields that must be supplied in order for the request to be considered valid.

You are only able to create customers where their email address is not already in use. Creating an account for a user that already exists will result in an error, and an HTTP 403 will be returned. Once a customer has been created, either through the API or if they've signed up themselves, their information can no longer be provided by API integrations.

Once a customer has been created, they will then receive an email introducing them to Escrow.com and to log in and set their password.

Note

While you are welcome to create customers independent of transactions, this step is not strictly necessary. Customer accounts will be created for any person involved in a transaction who does not already have an account at the time of transaction creation. The customer creation feature exists to allow you to set your customers up in the Escrow.com database, which in turn allows them to configure their account and go through the identity verification process before a transaction is started (this helps avoid transaction delays related to customer account configuration by getting that work done ahead of time).

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
curl "https://api.escrow.com/2017-09-01/customer" \
    -X POST \
    -u "email-address:your-api-key" \
    -H "Content-Type: application/json" \
    -d '
{
  "email": "john@escrow.com",
  "first_name": "John",
  "middle_name": "Kane",
  "last_name": "Smith",
  "address": {
    "line1": "1829 West Lane",
    "line2": "Apartment 301020",
    "city": "San Francisco",
    "state": "CA",
    "country": "US",
    "post_code": "10203"
  },
  "phone_number": "8885118600"
}'

Getting customer details

Retrieve your own customer details using the me resource.

1
2
curl "https://api.escrow.com/2017-09-01/customer/me"  \
  -u email-address:api-key

Example Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
{
    "address": {
        "city": "San Francisco",
        "country": "United States",
        "line1": "1234 Street Road",
        "post_code": "94104",
        "state": "CA"
    },
    "date_of_birth": "1900-01-01T00:00:00+00:00",
    "disbursement_methods": [
        {
            "account_name": "John Wick",
            "account_type": "savings",
            "bank_aba_routing_number": "123456789",
            "bank_account_number": "123456789",
            "bank_address": {
                "city": "San Francisco",
                "state": "CA"
            },
            "bank_name": "Bank of Coffee",
            "currency": "usd",
            "id": 35147,
            "type": "ach"
        }
    ],
    "email": "john.wick@escrow.com",
    "first_name": "John",
    "id": 900000,
    "last_name": "Wick",
    "middle_name": "Coffee",
    "phone_number": "+104433221111",
    "webhooks": [
        {
            "id": 7,
            "url": "https://www.escrow.com/webhook"
        }
    ]
}