Users

Read Me

get

Authorizations

BearerAuth

AuthorizationstringRequired

JWT token from Cognito, or lender API key (vd__). API keys can be obtained via GET /users/me/api-key.

Responses

200

Successful Response

application/json

get

/v1/users/me

HTTPcURLJavaScriptPython

GET /v1/users/me HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "email": "[email protected]",
  "firstName": "text",
  "lastName": "text",
  "dateJoined": "2026-03-25T13:21:41.356Z",
  "complianceAcceptDate": "2026-03-25T13:21:41.356Z",
  "lender": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "featureFlags": {
      "ANY_ADDITIONAL_PROPERTY": true
    },
    "hasScorecardConfigs": false
  },
  "availableLenders": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "featureFlags": {
        "ANY_ADDITIONAL_PROPERTY": true
      },
      "hasScorecardConfigs": false
    }
  ],
  "loginEmail": "[email protected]",
  "isTestProfile": false,
  "canManageTestProfiles": false
}

Accept Inquiry Terms

post

Authorizations

BearerAuth

AuthorizationstringRequired

JWT token from Cognito, or lender API key (vd__). API keys can be obtained via GET /users/me/api-key.

Responses

204

Successful Response

No content

post

/v1/users/me/accept-inquiry-terms

HTTPcURLJavaScriptPython

POST /v1/users/me/accept-inquiry-terms HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

Successful Response

No content

Get Api Key

get

Get the API key for the current user's lender.

Returns the first active key, creating a "Default" key if none exist.

Authorizations

BearerAuth

AuthorizationstringRequired

JWT token from Cognito, or lender API key (vd__). API keys can be obtained via GET /users/me/api-key.

Responses

200

Successful Response

application/json

get

/v1/users/me/api-key

HTTPcURLJavaScriptPython

GET /v1/users/me/api-key HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful Response

{
  "apiKey": "text",
  "name": "text",
  "isTest": true,
  "discoveryLimit": 1,
  "discoveryCount": 1,
  "isActive": true,
  "expiresAt": "2026-03-25T13:21:41.356Z",
  "createdAt": "2026-03-25T13:21:41.356Z"
}