onboard/v1/customer

[POST] /onboard/v1/customer

Onboard a new customer

The onboard section of Avenu's API is used for creating a customer. Onboard requests are sent through Avenu's know-your-customer (KYC) checks. The onboarding endpoint does not support batch processing. If you have an existing customer base please talk to a Sales associate for information on importing existing customers into the Avenu platform.

To onboard a new customer, provide at least two accepted IDs to the governmentIds array. One of which must be a social security number (SSN).

Device identification is optional, but it is passed to Hummingbird for help with case management (refunds, fraud, etc.).

Example [POST] Request

{{avenu_base_url}}/onboard/v1/customer
{
    "firstName" : "",                 
    "middleInitial" : "",             
    "lastName" : "",                  
    "dateOfBirth" : "",               
    "address" : "",                   
    "city" : "",                     
    "state" : "",                      
    "zipCode" : "",                    
    "country" : "",                    
    "citizenship" : "",                
    "email" : "",                      
    "mobilePhone" : "",                
    "governmentIds": [
        {
            "idType": "",               
            "idNumber": "",             
            "idIssuedBy" : "",         
            "idIssueDate" : "",        
            "idExpirationDate" : "",  
        },
    ],
    "deviceIdentity": {
        "deviceId": "",
        "deviceType": "",
        "deviceName": "",
        "deviceOperatingSystem": "",
        "deviceIPAddress": "",
        "deviceLocation": "",
        "deviceLongitude": "",
        "deviceLatitude": "",
        "deviceUser": "",
        "deviceIMEINumber" : "",
        "deviceTorEnabled" : "",
        "deviceFirstSeen" : "",
        "deviceLastSeen" : ""
  }
}

Input Parameters

ParameterFormatRequiredExplanation of function + error codes
"firstName"StringYThe Avenu customer's first name.
"middleInitial"StringNThe Avenu customer's middle initial.
"lastName"StringYThe Avenu customer's last name.
"dateOfBirth"String; ISO 8601 YYYY-MM-DDYThe Avenu customer's date of birth.
"address"StringYThe customer's physical street address.
"city"StringYThe customer's city.
"state"StringYThe customer's state.
"zipCode"StringNThe customer's zip code.
"country"String; ISO 3166 Alpha-3 country codeYThe address' country.
"citizenship"String; ISO 3166 Alpha-3 country codeYThe customer's citizenship.
"email"StringYThe customer's email.
"mobilePhone"StringYThe customer's mobile phone.
"idType"StringYGovernment ID type. See types table below.
"idNumber"StringYNumber on government id.
"idIssuedBy"StringYGovernment entity issuing id. Use USA for SSN. Use "US-AL" as an example for United States Alabama. US plus two letter state code.
"idIssueDate"String; ISO 8601 YYYY-MM-DDYGovernment entity issue date.
"idExpirationDate"String; ISO 8601 YYYY-MM-DDNGovernment entity expiration date.
"deviceId"StringNThe user's unique device identifier.
"deviceType"StringNThe type of the user's device
"deviceName"StringNThe name given to the user's device.
"deviceOperatingSystem"StringNThe OS of the user's device.
"deviceIPAddress"StringNCurrent IP Address for the device.
"deviceLocation"StringNCurrent location for the device.
"deviceLongitude"StringNDevice's location longitude.
"deviceLatitude"StringNDevice's location latitude.
"deviceUser"StringNThe name of the user of the device.
"deviceIMEINumber"StringNMobile device unique equipment identifier.
"deviceTorEnabled"BooleanNDevice is/is not using Tor browser.
"deviceFirstSeen"String; ISO 8601 YYYY-MM-DDNDate/Time the device was first used to access Avenu.
"deviceLastSeen"String; ISO 8601 YYYY-MM-DDNDate/Time the device was last used to access Avenu.

Example Response

{
    "customer": {
        "firstName" : "",
        "middleInitial" : "",
        "lastName" : "",
        "dateOfBirth" : "",
        "address" : "",
        "city" : "",
        "state" : "",
        "zipCode" : "",
        "country" : "",
        "citizenship" : "",
        "email" : "",
        "mobilePhone" : "",
        "governmentIds": [
            {
                "idType" : "",
                "idNumber" : "",
                "idIssuedBy" : "",
                "idIssueDate" : "",
                "idExpirationDate" : "",
            },
        ],
        "deviceIdentity": {
        "deviceId": "",
        "deviceType": "",
        "deviceName": "",
        "deviceOperatingSystem": "",
        "deviceIPAddress": "",
        "deviceLocation": "",
        "deviceLongitude": "",
        "deviceLatitude": "",
        "deviceUser": "",
        "deviceIMEINumber" : "",
        "deviceTorEnabled" : "",
        "deviceFirstSeen" : "",
        "deviceLastSeen" : ""
      }
  },
    "status": "",
    "statusInfo": "" 
}

Response Elements

(In addition to the original input parameters)

ElementDetails
statusThe customer's status code
statusInfoAdditional information associated with the status code

ID Type

ID TypeDescriptionRequired Fields
SSNSocial security Number; This is a required identifieridType, idNumber, idIssuedBy, idIssueDate
DRIVER_LICENSEDrivers License; Requires ID front and back scansidType, idNumber, idIssuedBy, idIssueDate, idExpirationDate
ID_CARDGovernment ID card; Requires ID front and back scansidType, idNumber, idIssuedBy, idIssueDate, idExpirationDate
PASSPORTPassport; Requires Passport first-page scanidType, idNumber, idIssuedBy, idIssueDate, idExpirationDate