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 new customer.
A customer is an individual or company that can be associated with a loan or line of credit account.

Create a Customer
Open Recipe
Link a Payment Profile to a Customer
Open Recipe
 Click here for more information about this request

Creating a Customer

Here's what you need to know about creating customers:

  • The Customers entity holds a vast amount of information. Multiple entities are nested within the Customers entity, such as PrimaryAddress, Phones, Employer, and more. You can edit each of these entities individually or in one request, but we've broken them into separate requests in this documentation..

  • 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 of this in action, look at the payload examples for our Create New Loan request. Creating a loan and linking a customer in one request requires you to use an existing customer or to create a new one beforehand. Here's why:

    When you create a new loan and link a customer all within the same request, you use the customer's ID in the payload and send the request through the Loans endpoint. Therefore, you will need a valid customer ID since you can't create a customer through the Loans endpoint.

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

Database

Need some direction on database tables? See the following articles:

Sample Payloads

{
    "status": "Active",
    "customerType": "customer.type.individual",
    "customerIdType": "customer.idType.ssn",
    "firstName": "John",
    "middleName": "H.",
    "lastName": "Doe",
    "ssn": "000000000",
    "birthDate": "1970-01-15",
    "driverLicense": "01-1029301",
    "gender": "customer.gender.male",
    "generationCode": "customer.generationCode.none",
    "accessUserName": "johndoeapiuser",
    "email": "johndoeapiuser@gmail.com",
    "PaymentAccounts": {
        "results": [
            {
                "active": 1,
                "isPrimary": 1,
                "isSecondary": 0,
                "title": "Checking Account",
                "type": "paymentAccount.type.checking",
                "CheckingAccount": {
                    "accountType": "bankacct.type.checking",
                    "token": ""
                }
            }
        ]
    },
    "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",
                "secondaryPhone": "2023346656"
            }
        ]
    },
    "Phones": {
        "results": [
            {
                "phone": "5551234567",
                "isPrimary": "1",
                "isSecondary": "0",
                "type": "customer.phoneType.cell",
                "carrierVerified": 1,
                "carrierName": "T-Mobile",
                "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
    },
    "__ignoreWarnings": true
}

{
    "status": "Active",
    "customerType": "customer.type.individual",
    "firstName": "John",
    "lastName": "Doe",
    "birthDate": "1970-01-15",
    "gender": "customer.gender.male",
    "generationCode": "customer.generationCode.none",
    "accessUserName": "johndoe",
    "email": "johndoe555@gmail.com",
    "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
    },
    "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
    },
    "__ignoreWarnings": true
}
Language
Credentials
Click Try It! to start a request and see the response here!