Create customer

POST

/v2/customers

Requisição

Authorization

Bearer Token

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Bodyapplication/jsonObrigatório

Examples

Respostas

🟢201Created

application/json

Customer created

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/v2/customers' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "individual",
    "name": "string",
    "email": "user@example.com",
    "document": "string",
    "document_type": "cpf",
    "phones": {
        "mobile_phone": {
            "country_code": "string",
            "area_code": "string",
            "number": "string"
        }
    },
    "address": {
        "line_1": "string",
        "line_2": "string",
        "zip_code": "string",
        "city": "string",
        "state": "string",
        "country": "string"
    },
    "metadata": {
        "property1": "string",
        "property2": "string"
    }
}'

Response Example

{
    "error": true,
    "message": "string",
    "customer": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "type": "individual",
        "name": "string",
        "email": "user@example.com",
        "document": "string",
        "document_type": "cpf",
        "phones": {
            "mobile_phone": {
                "country_code": "string",
                "area_code": "string",
                "number": "string"
            }
        },
        "address": {
            "line_1": "string",
            "line_2": "string",
            "zip_code": "string",
            "city": "string",
            "state": "string",
            "country": "string"
        },
        "metadata": {
            "property1": "string",
            "property2": "string"
        },
        "createdAt": "2019-08-24T14:15:22.123Z",
        "updatedAt": "2019-08-24T14:15:22.123Z"
    }
}

Modificado em 2025-11-15 15:11:05