Create a User

POST 
/user/create

Deprecation Notice

API v1 will be deprecated on January 31, 2026.
API v2 will be deprecated on February 28, 2026.
Please migrate to API v3 as soon as possible.

The "Create a User" section allows users to create a new user in the Agility Credit system. By providing essential information such as first name, last name, email, and phone number, users can successfully create a new user profile. Upon successful creation, users will receive a unique user ID.

Request

Header Parameters

Idempotency-Key stringrequired

A unique, idempotent key. We recommend to use a guid

Agc-Tenant-Id stringrequired

The tenant ID provided by Agility Credit.

Agc-User-Id stringrequired

The requestor user ID.

Agc-Applicant-Id string

If passed, will assign the report to that applicant. If not, will create a new applicant ID

application/json

Body

required

Inquiry request payload

first_namestringrequired
last_namestringrequired
emailstringrequired
phone_numberstringrequired

Responses

200

User created successfully

application/json

Schema

Schema

user_iduuidrequired

The unique identifier for the user.

created_atdate-timerequired

The timestamp when the user was created.

emailemailrequired

The email address of the user.

first_namestringrequired

The first name of the user.

last_namestringrequired

The last name of the user.

phonestringrequired

The phone number of the user.

updated_atdate-timerequired

The timestamp when the user was last updated.

Example (from schema)

{
  "user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created_at": "2024-07-29T15:51:28.071Z",
  "email": "user@example.com",
  "first_name": "string",
  "last_name": "string",
  "phone": "string",
  "updated_at": "2024-07-29T15:51:28.071Z"
}

400

Bad Request

application/json

Schema

Schema

statusstring
messagestring

Example (from schema)

{
  "status": "Bad Request - Invalid Parameters",
  "message": "Failed schema validation. Error: data.pull_type must be one of ['prequal', 'hard'], Path: ['data', 'pull_type'], Data: prequalification"
}

401

Unauthorized

application/json

Schema

Schema

messagestring

Example (from schema)

{
  "message": "Unauthorized"
}

429

Too Many Requests

application/json

Schema

Schema

messagestring

Example (from schema)

{
  "message": "Too Many Requests"
}

500

Internal Server Error

application/json

Schema

Schema

messagestring

Example (from schema)

{
  "message": "Agility Server Error"
}