Skip to main content
GET
Retrieve a user

Authorizations

X-Access-Client-Id
string
header
required

Client ID

X-Access-Secret
string
header
required

Client Access Key

Path Parameters

user_id
string
required

Query Parameters

When set to true, adds the payload from the account links endpoint.

Response

id
string
required
read-only

Unique identifier of the user.

Maximum string length: 32
Example:

"24d7e80942ce4ad58a93f70ce4115f5c"

external_user_id
string | null
required

External user id.

Maximum string length: 512
Example:

"12345"

created_at
string<date-time>
required
read-only

Timestamp when the user was created.

Example:

"2022-05-04T11:30:00Z"

updated_at
string<date-time>
required
read-only

Timestamp when the user was updated last time.

Example:

"2022-05-04T12:00:00Z"

first_name
string | null

First name of the user.

Maximum string length: 128
Example:

"John"

last_name
string | null

Last name of the user.

Maximum string length: 128
Example:

"Doe"

email
string<email> | null

User's email.

Maximum string length: 254
Example:

"john.doe@example.com"

phone
string | null

User's phone number in E.164 format (+ followed by the country code and number).

Maximum string length: 16
Example:

"+14155554193"

ssn
string | null

User's SSN, masked. Only the last 4 digits are visible — the leading digits are replaced with * (for example *****3333). When only the last 4 digits are on file, the value is fully masked (****).

Example:

"*****3333"

List of account Links associated with the user.

voie_report_id
string | null

GSE accepted income and employment verification report ID

Maximum string length: 32
Example:

"b19c454a98594b4084b71e3b62873d29"

voa_report_id
string | null

Verification of Assets report ID

Maximum string length: 32
Example:

"b19c454a98594b4084b71e3b62873d29"

income_insights_report_id
string | null

Income insights report ID

Maximum string length: 32
Example:

"b19c454a98594b4084b71e3b62873d29"

aim_check_report_id
string | null

AIM check report ID

Maximum string length: 64
Example:

"FM-1234-39aa1486ccca4bc19cda071ffc1ba392"