POST
/
customers
curl --request POST \
  --url https://prod.api.palomma.com/v1/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "documentType": "cc",
  "documentNumber": "<string>",
  "email": "<string>"
}'
{
  "id": "e79a0b74-3aba-4149-9f74-0bb5791a6ee6",
  "name": "Pepito Perez",
  "documentType": "cc",
  "documentNumber": "200220422",
  "email": "pepito@perez.com",
  "createdAt": "2023-10-26T21:28:34.152Z",
  "updatedAt": "2023-10-26T21:28:34.152Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required

Full name of the customer.

​
documentType
enum<string>
required

Type of identification document (cc, ce, nit).

Available options:
cc,
ce,
nit
​
documentNumber
string
required

Identification document number.

​
email
string
required

Email address of the customer.

Response

201
application/json
Customer created successfully.
​
id
string

Unique identifier for this customer.

Example:

"e79a0b74-3aba-4149-9f74-0bb5791a6ee6"

​
name
string

First and last name for a natural person, and company name for a juridical person.

Example:

"Pepito Perez"

​
documentType
enum<string>

Colombian ID type for customer.

Available options:
cc,
ce,
nit
Example:

"cc"

​
documentNumber
string

Colombian ID number for customer.

Example:

"200220422"

​
email
string

Customer’s email.

Example:

"pepito@perez.com"

​
createdAt
string

ISO string when the customer was created.

Example:

"2023-10-26T21:28:34.152Z"

​
updatedAt
string

ISO string when the customer was updated.

Example:

"2023-10-26T21:28:34.152Z"