Skip to main content
POST
/
v1
/
users
Create a User
curl --request POST \
  --url https://api.example.com/v1/users/

​
Overview

This endpoint creates a new user in the system.

​
Request

​
Endpoint

POST https://prod.transcrypts.com/v1/users/

​
Authentication

API authentication requires the following headers:
HeaderDescription
X-Access-Client-IdYour Client ID
X-Access-SecretYour Access Key

​
Request Body

The endpoint accepts a JSON request with user information.
ParameterTypeRequiredDescription
external_user_idstringYesExternal user identifier
first_namestringNoUser’s first name
last_namestringNoUser’s last name
emailstringNoUser’s email address
phonestringNoUser’s phone number
ssnstringNoUser’s Social Security Number

​
Example Request

{
  "external_user_id": "12345",
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@example.com",
  "phone": "+14155554193",
  "ssn": "222233333"
}

​
Response

​
Success Response (HTTP 201)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "external_user_id": "12345",
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@example.com",
  "phone": "+14155554193",
  "ssn": "222233333",
  "created_at": "2022-05-04T11:30:00Z",
  "updated_at": "2022-05-04T12:00:00Z"
}

​
Error Responses

Status CodeDescription
400Bad Request - Incorrect parameters provided
401Unauthorized - Missing or invalid authentication credentials
403Forbidden - Insufficient permissions