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

Parameter	Format	Required	Explanation of function + error codes
"firstName"	String	Y	The Avenu customer's first name.
"middleInitial"	String	N	The Avenu customer's middle initial.
"lastName"	String	Y	The Avenu customer's last name.
"dateOfBirth"	String; ISO 8601 YYYY-MM-DD	Y	The Avenu customer's date of birth.
"address"	String	Y	The customer's physical street address.
"city"	String	Y	The customer's city.
"state"	String	Y	The customer's state.
"zipCode"	String	N	The customer's zip code.
"country"	String; ISO 3166 Alpha-3 country code	Y	The address' country.
"citizenship"	String; ISO 3166 Alpha-3 country code	Y	The customer's citizenship.
"email"	String	Y	The customer's email.
"mobilePhone"	String	Y	The customer's mobile phone.
"idType"	String	Y	Government ID type. See types table below.
"idNumber"	String	Y	Number on government id.
"idIssuedBy"	String	Y	Government 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-DD	Y	Government entity issue date.
"idExpirationDate"	String; ISO 8601 YYYY-MM-DD	N	Government entity expiration date.
"deviceId"	String	N	The user's unique device identifier.
"deviceType"	String	N	The type of the user's device
"deviceName"	String	N	The name given to the user's device.
"deviceOperatingSystem"	String	N	The OS of the user's device.
"deviceIPAddress"	String	N	Current IP Address for the device.
"deviceLocation"	String	N	Current location for the device.
"deviceLongitude"	String	N	Device's location longitude.
"deviceLatitude"	String	N	Device's location latitude.
"deviceUser"	String	N	The name of the user of the device.
"deviceIMEINumber"	String	N	Mobile device unique equipment identifier.
"deviceTorEnabled"	Boolean	N	Device is/is not using Tor browser.
"deviceFirstSeen"	String; ISO 8601 YYYY-MM-DD	N	Date/Time the device was first used to access Avenu.
"deviceLastSeen"	String; ISO 8601 YYYY-MM-DD	N	Date/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)

Element	Details
status	The customer's status code
statusInfo	Additional information associated with the status code

ID Type

ID Type	Description	Required Fields
SSN	Social security Number; This is a required identifier	idType, idNumber, idIssuedBy, idIssueDate
DRIVER_LICENSE	Drivers License; Requires ID front and back scans	idType, idNumber, idIssuedBy, idIssueDate, idExpirationDate
ID_CARD	Government ID card; Requires ID front and back scans	idType, idNumber, idIssuedBy, idIssueDate, idExpirationDate
PASSPORT	Passport; Requires Passport first-page scan	idType, idNumber, idIssuedBy, idIssueDate, idExpirationDate