This request creates a customer.
Customers represent your borrowers within Secure Payments. Note the following when creating customers:
The customers entity holds customer information within Secure Payments.
Creating a customer via this request will store the borrower's information only in Secure Payments—not the Loan Management System. If you'd like borrower information to match in both systems, use the POST create customer request to the LMS API. Creating a customer within LMS will simultaneously create a customer within Secure Payments.
Once a customer has been created, Payment Profile information can be linked to the customer via the following separate requests:
PUT add bank account to customer profile
PUT add bank card to customer profile
Some fields are required to create a customer, while others are required if the customer will be associated with a Card. Take note of the payload parameter details to ensure you cover all of your bases.
Secure Payments does not check customer information for duplicate values. This could allow the creation of duplicate customers.
For an example of how customers work within the Secure Payments UI, take a look at our Secure Payments – Customers article.
{
"customer": {
"first_name": "Terry",
"last_name": "Bellevue",
"birthdate": "06/17/1988",
"gender": "male",
"email": "[email protected]",
"phone_number": "8011111111",
"generation_code": "none",
"ssn": "000000000",
"kyc_preferred_id_type": "ssn",
"driver_license": "A9289290",
"credit_limit": 12000,
"company_name": "Company A",
"contact_name": "John Doe",
"primary-address": {
"state": "UT",
"country": "USA",
"address1": "2000 S 1300 E ",
"zipcode": "84105",
"city": "SALT LAKE CITY"
},
"mail-address": {
"state": "UT",
"country": "USA",
"address1": "2000 S 1300 E ",
"zipcode": "84105",
"city": "SALT LAKE CITY"
}
}
}Results
Returns the customer values after successful customer creation. An error results in a "Failed to create customer" message. The errors object will contain information about the error (e.g. missing a required parameter).