API – Update a Customer
Updated 2 months ago
Introduction
This article covers the basics for updating a customer using the LoanPro API. You can also try this request yourself on our ReadMe page—an interactive API documentation page which lists each of our requests.
Updating a Customer
To update a customer, send a PUT request to the following URL.
PUT https://loanpro.simnang.com/api/public/api/1/odata.svc/Customers({customerId})The data must be sent over the request with a Content-Type of “application/json”. Below is an example of a request header.
Authorization: Bearer API_TOKEN
Autopal-Instance-ID: INSTANCE_ID
Content-Type: application/json
You can also update information in nested entities with a PUT request sent to the odata.svc/Customers() endpoint. Listed below is a sample body for an individual.
{
"id": 555,
"status": "Active",
"customerType": "customer.type.individual",
"customerIdType": "customer.idType.ssn",
"gender": "customer.gender.male",
"generationCode": "customer.generationCode.none",
"CustomFieldValues": {},
"birthDate": "1990-01-01",
"firstName": "John",
"middleName": "",
"lastName": "Dow",
"ssn": "855616513",
"driverLicense": "",
"accessUserName": "none@simnang.com",
"email": "none@simnang.com"
}The request body can contain the following fields that are specific to the customer:
Variable | Description |
customId | A custom id to identify the customer |
customerType | The type of customer (see API Customer Collections for more details) |
status | The status of the customer (options determined by tenant settings) |
firstName | The first name of the customer |
lastName | The last name of the customer |
middleName | The middle name of the customer |
birthDate | The birthday of the customer |
gender | The gender of the customer (see API Customer Collections) |
generation code | The Generation Code of the customer (see API Customer Collections) |
The customer’s email address | |
ssn | The Social Security Number of the customer (take care to not reveal this number to unauthorized parties) |
driverLicense | The driver license number of the customer |
companyName | Company name of the customer (if customer is a company) |
contactName | The name of the contact at the company (if customer is a company) |
customerIdType | The type of government ID number for a customer (see API Customer Collections) |
customerId | The government ID number for a customer |
creditLimit | The credit limit of a customer (if customer type is flooring) |
accessUserName | The username for the customer to use to access the customer website |
accessPassword | The password for the customer to use to access the customer website |
ofacMatch | Whether the customer matches any individual from the OFAC specially designated nationals list |
ofacTested | Whether the customer has been tested for OFAC compliance |
For any entities that you want to update that are nested inside of Customer, make sure you include the ID of the entity and the update property. For example, "__id": 123, "__update": true .