POST
/
customers
curl --request POST \
  --url https://prod.api.palomma.com/v0/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "reference": "<string>",
  "name": "<string>",
  "documentType": "cc",
  "documentNumber": "<string>",
  "email": "<string>",
  "phoneNumber": "<string>"
}'
{
  "id": "01HPR57X6QR5ZRKEEKBSDBW4RA",
  "reference": "<string>",
  "name": "Pepito Perez",
  "documentType": "cc",
  "documentNumber": "1037551022",
  "email": "pepito@gmail.com",
  "phoneNumber": "3013111111",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

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

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

​
documentType
enum<string>
required

Colombian ID type for customer.

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

Colombian ID number for customer.

​
email
string
required

Customer’s email.

​
phoneNumber
string
required

Customer’s phone number.

​
reference
string

Reference sent in by merchant to identify customer.

Response

200
application/json
Customer created successfully.
​
id
string

Unique identifier for this customer.

Example:

"01HPR57X6QR5ZRKEEKBSDBW4RA"

​
reference
string

Reference sent in by merchant to identify customer.

​
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
​
documentNumber
string

Colombian ID number for customer.

Example:

"1037551022"

​
email
string

Customer’s email.

Example:

"pepito@gmail.com"

​
phoneNumber
string

Customer’s phone number.

Example:

"3013111111"

​
createdAt
string

ISO string indicating when the customer was created.

​
updatedAt
string

ISO string indicating when the customer was updated.

Customer schemaList all customers