Create Person

Overview

This endpoint creates a new person record in the system. It accepts person details including their full name, email, client reference ID, and associated company ID.

Endpoint: {{baseURL}}/person
Method: POST
Content-Type: application/json Authentication: Bearer {{token}}.

Request Body Parameters

The request accepts a JSON payload with the following fields:

Parameter	Type	Required	Description
fullName	string	Yes	The full name of the person being created
email	string	Yes	The email address of the person (must be valid email format)
clientReferenceId	string	Yes	A unique reference identifier for the client's records

Example Request Body

{
  "fullName": "John Doe",
  "email": "john.doe@example.com",
  "clientReferenceId": "CLIENT-12345"
}

Response Codes

201 Created

Success - The person was created successfully.

Response Body:

{
  "personId": "unique-person-identifier"
}

The personId returned in the response is the unique identifier for the newly created person and should be stored for future reference.

422 Unprocessable Entity

Validation Error - The request contains invalid parameters or failed validation.

Response Body:

{
  "message": "Validation error description"
}

Common causes:

• Invalid email format
• Missing required fields
• Invalid companyId (company does not exist)
• Duplicate clientReferenceId

500 Internal Server Error

Server Error - An unexpected error occurred on the server.

Response Body:

{
  "message": "Error description"
}

This indicates a server-side issue that should be reported if it persists.