Create a user
Last updated
Last updated
POST https://sandbox-api.com/v1/users
Returns the user object if successful. Returns an error if create parameters are invalid (e.g. specifying an invalid phone number or date of birth). Date of birth and SSN are not included in the response as they are sensitive personal data.
| Name | Type | Description |
|---|---|---|
address*
object
The user's address. Must be a valid US address. For the address schema, see The user object.
middle_name
string
The user's middle name. Must pass the regex ^([aA-zZ]+[,.]?[ ]?|[aA-zZ]+['’-]?)+$
first_name*
string
The user's first name. Must pass the regex ^([aA-zZ]+[,.]?[ ]?|[aA-zZ]+['’-]?)+$
email*
string
The user's email address.
dob*
string
The user's date of birth, formatted as YYYY/MM/DD.
The minimum age accepted is 18 years old.
credit_report_xml_gzip
string
The user's credit report, gzipped with base64 encoding.
asset_report_json_gzip
string
The user's Plaid asset report, gzipped with base64 encoding.
ssn*
string
The user's social security number (SSN). The SSN must be AES encrypted In CBC Mode using your secret_key (see Creating and Managing Users for more detail)
Can be formatted with or without dashes (ie 1112223333 and 111-222-3333 are accepted)
phone*
string
The user's 10-digit phone number. Must be a valid US phone number.
last_name*
string
The user's last name. Must pass the regex ^([aA-zZ]+[,.]?[ ]?|[aA-zZ]+['’-]?)+$