Customers
Create a Customer
The customer object represents your customer's identity. You can then verify the identity of this customer and associate them with other people and accounts. Note that if no shipping_address attribute is provided in the request, the shipping_address will be set to a copy of the legal_address.
post/customers
Headers
Idempotency-Keystring
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7
An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.
Request body
Example request
{
"addresses": [
{
"address_line_1": "100 Main St.",
"address_line_2": "Suite 99",
"address_type": "SHIPPING",
"city": "New York",
"country_code": "US",
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"is_registered_agent": true,
"nickname": "Home",
"postal_code": "28620",
"state": "NY"
}
],
"ban_status": "ALLOWED",
"creation_time": "2010-05-06T12:23:34.321Z",
"email": "alice@example.com",
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"kyc_last_run": "2010-05-06T12:23:34.321Z",
"last_updated_time": "2010-05-06T12:23:34.321Z",
"legal_address": {
"address_line_1": "100 Main St.",
"address_line_2": "Suite 99",
"address_type": "SHIPPING",
"city": "New York",
"country_code": "US",
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"is_registered_agent": true,
"nickname": "Home",
"postal_code": "28620",
"state": "NY"
},
"middle_name": "Anne",
"phone_number": "+14374570680",
"related_customers": [
{
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"relationship_role": "CUSTODIAN"
}
],
"shipping_address": {
"address_line_1": "100 Main St.",
"address_line_2": "Suite 99",
"address_type": "SHIPPING",
"city": "New York",
"country_code": "US",
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"is_registered_agent": true,
"nickname": "Home",
"postal_code": "28620",
"state": "NY"
},
"spend_control_ids": [
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
],
"ssn": "123-45-6789",
"tenant": "abcdef_ghijkl",
"dob": "2000-01-01",
"first_name": "Jane",
"last_name": "Smith"
}Response
Created customer
Example response
{
"vendor_info": {
"vendor_data": {
"loanpro": {
"customer_id": 12345
}
}
},
"addresses": [
{
"address_line_1": "100 Main St.",
"address_line_2": "Suite 99",
"address_type": "SHIPPING",
"city": "New York",
"country_code": "US",
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"is_registered_agent": true,
"nickname": "Home",
"postal_code": "28620",
"state": "NY"
}
],
"ban_status": "ALLOWED",
"creation_time": "2010-05-06T12:23:34.321Z",
"email": "alice@example.com",
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"kyc_last_run": "2010-05-06T12:23:34.321Z",
"last_updated_time": "2010-05-06T12:23:34.321Z",
"legal_address": {
"address_line_1": "100 Main St.",
"address_line_2": "Suite 99",
"address_type": "SHIPPING",
"city": "New York",
"country_code": "US",
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"is_registered_agent": true,
"nickname": "Home",
"postal_code": "28620",
"state": "NY"
},
"middle_name": "Anne",
"phone_number": "+14374570680",
"related_customers": [
{
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"relationship_role": "CUSTODIAN"
}
],
"shipping_address": {
"address_line_1": "100 Main St.",
"address_line_2": "Suite 99",
"address_type": "SHIPPING",
"city": "New York",
"country_code": "US",
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"is_registered_agent": true,
"nickname": "Home",
"postal_code": "28620",
"state": "NY"
},
"spend_control_ids": [
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
],
"ssn": "123-45-6789",
"tenant": "abcdef_ghijkl",
"dob": "2000-01-01",
"first_name": "Jane",
"last_name": "Smith"
}