Sign in

v1

latestOpenAPI 3.0.32026-07-26152525.0 KB
users

Create a new user

post/api/v1/users

Request body

clientUserIdstring required
clientUserEmailstring
firstNamestring
middleNamestring
lastNamestring
gender'male' | 'female' | 'other'
dateOfBirthstring

A string with one of the following formats:

  • YYYY-MM-DD Example: 1990-12-30
  • M/D/YY Example: 3/23/89
  • M/D/YYYY Example: 2/12/2004
  • YYYY-MM-DDTHH:mmZ as ECMA-262 Example: 1990-12-30T00:00Z the timezone is optional
  • YYYY-MM-DDTHH:mm:ssZ as ECMA-262 Example: 1990-12-30T00:00:00Z the timezone is optional
  • YYYY-MM-DDTHH:mm:ss.sssZ as ECMA-262 Example: 1990-12-30T00:00:00.000Z the timezone is optional
ssnstring
phonestring
autoInviteboolean
orderTypestring
clientDataobject
suggestedSourcesstring[]
conditionsstring[]

Include order-specific conditions or additional instructions for APS retrieval orders

Response

Created

firstNamestring
lastNamestring
dateOfBirthstring date-time
humanIdstring required
clientUserEmailstring required
createdAtstring date-time required
updatedAtstring date-time required
statusstring required
suggestedSourcesstring[]
inviteLinkstring

Example response

[
  {
    "dateOfBirth": "1968-02-13T00:00:00.000Z"
  }
]