Loan Management System APISecure Payments API
API Reference

Create Customer

post https://loanpro.simnang.com/api/public/api/1/odata.svc/Customers

This request creates a customer profile.

Recipes
Create a Customer
Open Recipe
Link a Payment Profile to a Customer
Open Recipe
   Click here to learn more about this request

A customer is an individual or company that can be associated with a loan:

  • Customers are represented by the Customers entity. The Customers entity holds a vast amount of information: multiple entities are nested within the Customers entity, such as PrimaryAddress, Phones, Employer, and more. These entities can be edited individually or in one request, but we've broken them into separate requests in this documentation to simplify things.

  • There are three types of customers within LoanPro:

    • Individual: profiles for individuals in a business-to-consumer scenarios
    • Company: profiles for those in generic business-to-business scenarios
    • Flooring: profiles for those in business-to-business scenarios who have flooring loan accounts

  • The system provides a transaction warning when it detects a duplicate customer. These warnings can be ignored by using the __ignoreWarnings field. The following fields are checked for duplicates:

    • Social Security/Social Insurance Number
    • Email Address
    • Phone Number
    • Primary Address
    • Mailing Address

  • Many users like to create a customer and link a loan within one request. To see an example, look at the payload examples for our Create New Loan request. Creating a loan and linking a customer in one request requires an existing customer or to create a new one beforehand. Here's why:

    When creating a new loan and linking a customer all within the same request, the customer's ID is used in the payload and send the request through the Loans endpoint. Therefore, a valid customer ID is needed since a customer can't be created through the Loans endpoint.

For an example of how customer information works within the UI, take a look at our Customer Overview article.

Database

For information regarding customer database tables, see the following articles:

{
    "status": "Active",
    "customerType": "customer.type.individual",
    "customerIdType": "customer.idType.ssn",
    "firstName": "John",
    "lastName": "Doe",
    "birthDate": "1970-01-15",
    "ssn": "000000000",
    "gender": "customer.gender.male",
    "generationCode": "customer.generationCode.none",
    "accessUserName": "johndoeapiuser",
    "email": "[email protected]",
    "__ignoreWarnings": true,
    "PaymentAccounts": {
        "results": [
            {
                "active": 1,
                "isPrimary": 0,
                "isSecondary": 1,
                "title": "Checking Account",
                "type": "paymentAccount.type.checking",
                "CheckingAccount": {
                    "accountType": "bankacct.type.checking",
                    "token": "QVFJREFIalVqRl..."
                },
                "CreditCard": {}
            }
        ]
    },
    "Employer": {
        "phone": "8642543322",
        "payDate": "2020-01-30",
        "Address": {
            "address1": "9 Michigan Ave",
            "city": "Chicago",
            "state": "geo.state.IL",
            "zipcode": "60602",
            "country": "company.country.usa"
        },
        "hireDate": "2015-01-15",
        "incomeFrequency": "customerEmployer.incomeFrequency.annually",
        "payDateFrequency": "customerEmployer.payDateFrequency.biWeekly",
        "income": 75000,
        "companyName": "Chicago Dawgs Stands",
        "title": "Owner"
    },
    "References": {
        "results": [
            {
                "name": "Tony Doe",
                "relation": "customerReference.relation.brother",
                "Address": {
                    "country": "company.country.usa",
                    "address1": "2600 Sheridan Road",
                    "zipcode": "60201",
                    "city": "Evanston",
                    "state": "geo.state.IL"
                },
                "primaryPhone": "2024456655"
            }
        ]
    },
    "Phones": {
        "results": [
            {
                "phone": "5551234567",
                "isPrimary": "1",
                "isSecondary": "0",
                "type": "customer.phoneType.cell",
                "carrierVerified": 1,
                "isLandLine": 0,
                "__ignoreWarnings": true
            }
        ]
    },
    "PrimaryAddress": {
        "address1": "201 E Randolph St",
        "city": "Chicago",
        "state": "geo.state.IL",
        "zipcode": "60602",
        "country": "company.country.usa",
        "geoLat": "41.882648",
        "geoLon": "-87.623102",
        "verify": true
    },
    "CreditScore": {
        "equifaxScore": 711,
        "transunionScore": 692,
        "experianScore": 698
    },
    "MailAddress": {
        "address1": "201 E Randolph St",
        "city": "Chicago",
        "state": "geo.state.IL",
        "zipcode": "60602",
        "country": "company.country.usa",
        "geoLat": "41.882648",
        "geoLon": "-87.623102",
        "verify": true
    }
}
Language
Credentials
Click Try It! to start a request and see the response here!