Create New Customer

This request allows you to create a new customer.

General

A customer is any individual or company that can be associated with a loan. Here's what you need to know about creating customers:

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

  • The system provides a transactional warning when it detects a duplicate customer. However, 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 tend to want to simultaneously link a customer when they create a new loan within one request. This is possible, and we have a payload example on our Create New Loan request. If this is the case for you, you will need to use an existing customer or create a new loan 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 more information on how to create a customer in the API, see our API – Creating a Customer article on our help site.

And for examples on how customers work within the UI, see our Customer Overview article.

Database

For information on Customer database tables, see the following articles:

{
    "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",
    "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": 3,
                "customFieldValue": "500.00",
                "__id": 3,
                "__update": true
            }
        ]
    },
    "__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

This request offers a great deal of customization. We have provided some sample information to show how this request is built, but feel free to experiment with different values.

To get a 200 response, you can simply click Try It. However, if you would like to change some values, ensure that you fulfill the required fields. While not all fields in this request are required, it is best practice to provide as much information for a new customer as possible. You can expand each of the nested objects in this payload by clicking the "+" icon.

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.

Language
Authentication
Click Try It! to start a request and see the response here!