v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB

Customers | Clientes

Create or update a customer | Criar ou atualizar cliente

Processes KYC data to create a new customer or update an existing one. | Processa dados KYC para criar um novo cliente ou atualizar um existente.

post/customers

Request body

documentstring required

CPF (11 or 14 without punctuation) or CNPJ (14 or 18 with punctuation)

emailstring

full_namestring required

origin_datestring required

Expecting YYYY-MM-DD

phonestring

E.g., 11999998888 or (11) 99999-8888

type'PF' | 'PJ' required

zip_codestring

E.g., 12345-678 or 12345678

Example request

{
  "document": "92299569022",
  "email": "renata.ana.pereira@orthoi.com.br",
  "full_name": "Luan Leandro Pereira",
  "origin_date": "1987-05-20",
  "phone": "5562999361583",
  "zip_code": "74911444"
}

Response

Customer updated successfully | Cliente atualizado com sucesso

codestring

messagestring

request_idstring

Example response

{
  "code": "success",
  "data": {
    "created_at": "2025-07-15T15:18:15.348307-03:00",
    "document": "01524709131",
    "email": "renata.ana.pereira@orthoi.com.br",
    "full_name": "Luan Leandro Pereira",
    "id": "29358f0d-581e-49cb-a90a-2f82fe1197f7",
    "origin_date": "1986-04-21",
    "phone": "5562984361583",
    "type": "PF",
    "updated_at": "2025-07-15T15:18:15.399689901-03:00",
    "zip_code": "74918054"
  },
  "message": "Customer data processed successfully.",
  "request_id": "0c04ebd7-fa91-4087-965f-e05021775b38"
}