Create New Customer

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

This request creates a new customer.

Recipes

Create a Customer

Open Recipe

Link a Payment Profile to a Customer

Open Recipe

General

A customer is an individual or company that can be associated with a loan. 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 to simplify things.
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

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",
     "gender": "customer.gender.male",
     "generationCode": "customer.generationCode.none",
     "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",
                    "_index": 0,
                    "type": "customer.phoneType.cell",
                    "carrierVerified": 1,
                    "__lookupInProgress": true,
                    "isLandLine": 0,
                    "__isDirty": false,
                    "delete": false,
                    "__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
     },
     "accessUserName": "johndoeapiuser",
     "email": "[email protected]",
     "__ignoreWarnings": true
}

{
    "status": "Active",
    "customerType": "customer.type.individual",
    "customerIdType": "customer.idType.ssn",
    "firstName": "John",
    "lastName": "Doe",
    "ssn": "111223333",
    "birthDate": "1970-01-15",
    "driverLicense": "196230586",
    "gender": "customer.gender.male",
    "generationCode": "customer.generationCode.none",
    "PaymentAccounts": { // 👈 This object holds payment profile information.
        "results": [
            {
                "active": 1,
                "isPrimary": 0,
                "isSecondary": 1,
                "title": "API Example Account",
                "type": "paymentAccount.type.checking",
                "CheckingAccount": {
                    "accountType": "bankacct.type.checking",
                    "token": "QVFJREFIalVqRl..."
                },
                "CreditCard": {}
            }
        ]
    },
    "References": {
        "results": [
            {
                "name": "Johnathan Doe",
                "relation": "customerReference.relation.father",
                "Address": {
                    "country": "company.country.usa",
                    "address1": "123 Theology St",
                    "zipcode": "45402",
                    "city": "Dayton",
                    "state": "geo.state.OH"
                },
                "primaryPhone": "2024456655"
            }
        ]
    },
    "Phones": {
        "results": [
            {
                "phone": "5551234567",
                "isPrimary": "1",
                "isSecondary": "0",
                "_index": 0,
                "type": "customer.phoneType.cell",
                "carrierVerified": 1,
                "__lookupInProgress": true,
                "isLandLine": 0,
                "__isDirty": false,
                "delete": false,
                "__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
    },
    "accessUserName": "johndoe",
    "email": "[email protected]",
    "Employer": {
        "phone": "8642543322",
        "payDate": "2020-01-30",
        "Address": {
            "address1": "175 N State St",
            "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",
        "title": "Owner"
    },
    "CustomFieldValues": {
        "results": [
            {
                "customFieldId": 93,
                "customFieldValue": "Yes"
            }
        ]
    },
    "__ignoreWarnings": true
}

📘
Try It Instructions
Our pages often provide sample payload information so that you can try requests yourself. This request is ready for you—expand the object by clicking the "+" symbol and hit the Try It button to send the request.
If you would like to try this request with your own tenant account, make sure to change the headers to match your own authentication information.