Create User

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

The Create User function creates a user profile or an object on the Authenticate system. This function returns a unique User Access Code(UAC). This UAC can be created multiple times for the same information.

User Access Code (UAC) is a v4 UUID and will be used in subsequent API calls to reference the respective user.


📘

Important Notes:

  1. The FirstName, LastName, DateOfBirth, and Email fields listed here are required. An error will be thrown if one or more fields are omitted, provided as empty strings ("), or sent as null; fields that are not required should be entered as null in case they are unavailable.
  2. HouseNumber should be only numeric, and StreetName should be a string. These two fields are mandatory for successfully completing background checks.
  3. The country value matches a list of country codes. For example, the USA is for the United States, CAN is for Canada, etc. For a full list of supported countries, please see this list.
  4. The ssn field is optional and can be full (9 digits) or partial (last 4 digits).
Body Params

Create a new User

string
required

First name of the user

string

Middle name of the user

string
required

Last name of the user

string
required

Date of Birth

string
required

Email address of the user

string

Phone number of the user

string

House Number of the user

string

Street Name of the user

string

Address of the user (DEPRECATED, add houseNumber and streetName instead)

string

City of the user

string

State of the user

string

Zip Code of the user

string

Social Security Number of the user (Full 9 digit SSN or First 5 digits or Last 4 digits)

string

Country of the user (ISO 3166-1 alpha-3)

Responses

Language
Credentials
Bearer
API KEY
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json