v4

latestOpenAPI 3.0.12026-07-3189233676.2 KB

Users

Retrieve a user

This endpoint retrieves a user.

get/v1/users/{user_id}/

Query parameters

list_linksboolean

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

Response

idstring required

Unique identifier of the user.

external_user_idstring nullable required

External user id.

first_namestring nullable

First name of the user.

last_namestring nullable

Last name of the user.

emailstring email nullable

User's email.

phonestring nullable

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

ssnstring nullable

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 (****).

created_atstring date-time required

Timestamp when the user was created.

updated_atstring date-time required

Timestamp when the user was updated last time.

voie_report_idstring nullable

GSE accepted income and employment verification report ID

voa_report_idstring nullable

Verification of Assets report ID

income_insights_report_idstring nullable

Income insights report ID

aim_check_report_idstring nullable

AIM check report ID

Example response

{
  "id": "24d7e80942ce4ad58a93f70ce4115f5c",
  "external_user_id": "12345",
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@example.com",
  "phone": "+14155554193",
  "ssn": "*****3333",
  "created_at": "2022-05-04T11:30:00Z",
  "updated_at": "2022-05-04T12:00:00Z",
  "links": [
    {
      "id": "48427a36d43c4d5aa6324bc06c692456",
      "access_token": "****************************7610",
      "created_at": "2022-06-07T15:00:00Z",
      "updated_at": "2022-06-30T15:00:00Z",
      "deleted_at": "2022-06-30T15:00:00Z",
      "tracking_info": "user123456",
      "status": "new",
      "user_external_id": "user123456",
      "provider_id": "adp",
      "provider": {
        "id": "adp",
        "name": "ADP"
      },
      "company_mapping": {
        "id": "meta",
        "name": "Meta"
      },
      "link_hash": "bc917458a3da4b2c8cc8282aa1707aaa",
      "allowed_products": [
        "income"
      ],
      "initial_product_type": "income",
      "data_source": "payroll"
    }
  ],
  "voie_report_id": "b19c454a98594b4084b71e3b62873d29",
  "voa_report_id": "b19c454a98594b4084b71e3b62873d29",
  "income_insights_report_id": "b19c454a98594b4084b71e3b62873d29",
  "aim_check_report_id": "FM-1234-39aa1486ccca4bc19cda071ffc1ba392"
}