This section provides an overview to customer creation.
The customer entity represents borrowers in Secure Payments. You can retrieve customer information, create a customer, search customers, and update a customer.
Secure Payments and the Loan Management System contain seperate customer entities. Creating a customer in Secure Payments will not create a corresponding customer in LMS. After creating a customer in Secure Payments, you will need to create an identical customer using the LMS API. However, if you create a customer in LMS, it will create a corresponding customer in Secure Payments.
The customer entity in Secure Payments holds a wide variety of customer information. When creating a customer, the primary-address and mail-address entities can be associated with the customer instead of entering values for address fields.
Unlike LMS, Secure payments does not check customer information which could allow the creation of duplicate customers. You will find the key-value pairs for the customer below.
Key-value pairs
| Value: | Definition: |
|---|---|
first_name | The customer's first name. |
middle_name | The customer's middle name. |
last_name | The customer's last name. |
birthdate | The customer's birthday. |
gender | The customer's gender. |
email | The customer's email address. |
phone_type | The type of phone number (e.g. home, cell phone). |
phone_number | The customer's phone number. |
generation_code | The customer's generational suffix (e.g. Sr, Jr, III). |
ssn | The customer's social security number. |
kyc_preferred_id_type | The type of KYC document (e.g. ssn, passport). |
driver_license | The customer's driver's license ID. |
credit_limit | The credit limit on the customer's account. |
company_name | The company name if the customer is a company. |
contact_name | The company's contact name if the customer is a company. |
primary_zipcode | The customer's primary zip code. |
primary_address1 | Line one of the customer's primary address. |
primary_address2 | Line two of the customer's primary address. |
mail_zipcode | The customer's mailing zip code. |
mail_address1 | Line one of the customer's mailing address. |
mail_address2 | Line two of the customer's mailing address. |
primary_country | The customer's primary country. |
primary_state | The customer's primary state. |
primary_city | The customer's primary city. |
mail_country | The customer's mailing country. |
mail_state | The customer's mailing state. |
mail_city | The customer's mailing city. |
udpated | The update status. |
created | The creation date of the customer object. |
id | The customer's ID. |
primary-address object | The customer's primary address entity. > For more information see the primary_address table below. |
mail-address object | The customer's mailing address entity. > For more information see the mail_address table below. |
Primary address
This object holds the primary address information for the customer's entity.
| Value: | Definition: |
|---|---|
address1 | Line one of the cardholder's street address. |
address2 | Line two of the cardholder's street address. |
city | The cardholder's city. |
state | The cardholder's state. |
zipcode | The cardholder's zip code. |
country | The cardholder's country. |
Mail address
This object holds the mailing address information for the customer's entity.
| Value: | Definition: |
|---|---|
address1 | Line one of the cardholder's street address. |
address2 | Line two of the cardholder's street address. |
city | The cardholder's city. |
state | The cardholder's state. |
zipcode | The cardholder's zip code. |
country | The cardholder's country. |
For an example of how Customers work within the Secure Payments UI, take a look at our Secure Payments – Customers article.