# Criar um novo cliente

Crie um novo cliente para enviar ou solicitar fundos.

Endpoint: POST /payments/br/customers/
Version: 1.223.0
Security: basicAuth

## Header parameters:

  - `X-Belvo-API-Resource-Version` (string)
    Cabeçalho indicando qual versão da API de Pagamentos você deseja usar. Atualmente, isso é aplicável apenas para Contas Bancárias, Clientes e Autorizações de Pagamento no Brasil. No caso de você estar usando nosso produto de Autorizações de Pagamento, então você deve enviar este cabeçalho configurado para Payments-BR.V2.

{% admonition type="warning" name="Em Breve" %}
  Esta versão está em breve lançamento. Portanto, pequenas alterações ou bugs podem ocorrer. Se você encontrar algum problema, entre em contato com seu representante da Belvo.
{% /admonition %}
    Enum: "Payments-BR.V2"

## Request fields (application/json):

  - `body` (object) — one of:
    - V2 - Criar Cliente:
      - `identifier` (string, required)
        O CPF (11 dígitos) ou CNPJ (14 dígitos) do cliente.
        Example: "12345678901122"
      - `name` (string, required)
        O nome completo ou razão social do cliente.
        Example: "Frangos Enlatados"
      - `external_id` (string)
        Um identificador exclusivo adicional para o recurso para fins internos.

{% admonition type="success" name="Altamente Recomendado" %}
  Recomendamos usar este campo para armazenar seu próprio identificador exclusivo para cada recurso (cliente, conta bancária, intenção de pagamento ou inscrição). Isso pode ser útil para rastrear o recurso em seu sistema e para fins de depuração.
{% /admonition %}
        Example: "4b8a81a0-e33c-45a6-8567-479efb105f73"
    - V1 - Criar Cliente:
      - `identifier` (string, required)
        O número de CPF ou CNPJ do cliente.
        Example: "10187609363"
      - `name` (string)
        O nome completo do cliente que você deseja criar.
        Example: "Gustavo Veloso"
      - `external_id` (string)
        Um identificador exclusivo adicional para o recurso para fins internos.

{% admonition type="success" name="Altamente Recomendado" %}
  Recomendamos usar este campo para armazenar seu próprio identificador exclusivo para cada recurso (cliente, conta bancária, intenção de pagamento ou inscrição). Isso pode ser útil para rastrear o recurso em seu sistema e para fins de depuração.
{% /admonition %}
        Example: "4b8a81a0-e33c-45a6-8567-479efb105f73"
      - `email` (string)
        O endereço de e-mail do cliente.
        Example: "gustavo.veloso@musicabrazil.br"
      - `phone` (string,null)
        O número de telefone do cliente.
        Example: "+5511987654321"
      - `address` (string,null)
        O endereço físico do cliente.
        Example: "Rua de Gustavo Veloso 432, 70200 Brasilia"

## Response 201 fields (application/json):

  - `body` (object) — one of:
    - V2 - Cliente:
      - `id` (string, required)
        Identificador único da Belvo para o item atual.
        Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"
      - `created_at` (string, required)
        O carimbo de data e hora ISO-8601 de quando o ponto de dados foi criado no banco de dados da Belvo.
        Example: "2022-02-09T08:45:50.406032Z"
      - `updated_at` (string, required)
        O carimbo de data e hora ISO-8601 de quando o ponto de dados foi atualizado no banco de dados da Belvo.
        Example: "2022-02-09T08:45:50.406032Z"
      - `name` (string, required)
        O nome completo ou razão social do cliente.
        Example: "Frangos Enlatados"
      - `identifier` (string, required)
        O CPF (11 dígitos) ou CNPJ (14 dígitos) do cliente.
        Example: "12345678901122"
      - `external_id` (string)
        Um identificador exclusivo adicional para o recurso para fins internos.

{% admonition type="success" name="Altamente Recomendado" %}
  Recomendamos usar este campo para armazenar seu próprio identificador exclusivo para cada recurso (cliente, conta bancária, intenção de pagamento ou inscrição). Isso pode ser útil para rastrear o recurso em seu sistema e para fins de depuração.
{% /admonition %}
        Example: "4b8a81a0-e33c-45a6-8567-479efb105f73"
    - V1 - Cliente:
      - `id` (string, required)
        Identificador único da Belvo para o item atual.
        Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"
      - `created_at` (string, required)
        O carimbo de data e hora ISO-8601 de quando o ponto de dados foi criado no banco de dados da Belvo.
        Example: "2022-02-09T08:45:50.406032Z"
      - `created_by` (string, required)
        O ID único para o usuário que criou este item.
        Example: "bcef7f35-67f2-4b19-b009-cb38795faf09"
      - `customer_type` (string, required)
        O tipo de cliente. Pode ser:

  - INDIVIDUAL
  - BUSINESS (apenas OFPI Brasil)
        Enum: "INDIVIDUAL", "BUSINESS"
      - `name` (string,null, required)
        O nome completo do cliente.
        Example: "Gustavo Veloso"
      - `external_id` (string)
        Um identificador exclusivo adicional para o recurso para fins internos.

{% admonition type="success" name="Altamente Recomendado" %}
  Recomendamos usar este campo para armazenar seu próprio identificador exclusivo para cada recurso (cliente, conta bancária, intenção de pagamento ou inscrição). Isso pode ser útil para rastrear o recurso em seu sistema e para fins de depuração.
{% /admonition %}
        Example: "4b8a81a0-e33c-45a6-8567-479efb105f73"
      - `country` (string,null, required)
        O país de residência do cliente.
- BRA (🇧🇷 Brasil)
        Enum: "BRA", "null"
      - `email` (string,null, required)
        O endereço de e-mail do cliente.
        Example: "gustavo.veloso@musicabrazil.br"
      - `identifier` (string, required)
        O número do documento da identidade do cliente (dependendo do identifier_type).
        Example: 191
      - `identifier_type` (string, required)
        O tipo de documento de identificação do cliente. Para o Brasil, isso pode ser:

- CPF (quando customer_type é INDIVIDUAL)
- CNPJ (quando customer_type é BUSINESS)
        Enum: "CPF", "CNPJ"
      - `address` (string,null)
        O endereço físico dos clientes.
        Example: "Rua de Gustavo Veloso 432, 70200 Brasilia"
      - `phone` (string,null)
        O número de telefone do cliente.
        Example: "+5511987654321"

## Response 400 fields (application/json):

  - `code` (string, required)
    Um código de erro único (null, does_not_exist, required, already_registered, invalid_choice, max_length, min_length, blank, null, cancellation_error, idempotency_key_invalid) que permite classificar e tratar o erro de forma programática.
    Example: "required"

  - `message` (string, required)
    Uma breve descrição do erro.

A descrição pode ser (entre outras):

  - Este campo é obrigatório.
  - Objeto com nome=narnia não existe.
  - Este campo não pode ser nulo.
  - Este campo não pode estar em branco.
  - Este cliente já está registrado.
  - Certifique-se de que este campo tenha pelo menos 2 caracteres.
  - Certifique-se de que este campo não tenha mais de 4 caracteres.
  - O valor inserido não é válido.
  - Você deve definir todos os campos obrigatórios: username, password, username_type.
  - Payment Intent não pode ser cancelado porque não está SCHEDULED.
  - Payment Intent não pode ser cancelado pois o horário limite (23:59:00) já passou.
  - A chave de idempotência fornecida é inválida.
    Example: "This field is required."

  - `request_id` (string, required)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

  - `field` (string,null)
    Nome do campo onde o erro foi encontrado.

> Nota: Este campo só está presente quando o erro está relacionado a um campo específico.
    Example: "institution"

## Response 403 fields (application/json):

  - `code` (string)
    Um código de erro único (access_to_resource_denied) que permite classificar e tratar o erro programaticamente.

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com 403 access_to_resource_denied.
    Example: "access_to_resource_denied"

  - `message` (string)
    Uma breve descrição do erro.

Para erros access_to_resource_denied, a descrição é:

  - You don't have access to this resource..
    Example: "You don't have access to this resource."

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 404 fields (application/json):

  - `code` (string)
    Um código de erro único (not_found) que permite classificar e lidar com o erro programaticamente.
    Example: "not_found"

  - `message` (string)
    Uma breve descrição do erro.

Para erros not_found, a descrição é:

  - Not found
    Example: "Not found"

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 408 fields (application/json):

  - `code` (string)
    Um código de erro único (request_timeout) que permite classificar e lidar com o erro programaticamente.

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com erros 408 request_timeout.
    Example: "request_timeout"

  - `message` (string)
    Uma breve descrição do erro.

Para erros de request_timeout, a descrição é:

  - The request timed out, you can retry asking for less data by changing your query parameters.
    Example: "The request timed out, you can retry asking for less data by changing your query parameters"

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 500 fields (application/json):

  - `code` (string)
    Um código de erro único (unexpected_error) que permite classificar e tratar o erro de forma programática.

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com erros 500 unexpected_error.
    Example: "unexpected_error"

  - `message` (string)
    Uma breve descrição do erro.

Para erros unexpected_error, a descrição é:

  - Belvo não consegue processar a solicitação devido a um problema interno do sistema ou a uma resposta não suportada de uma instituição.
    Example: "Belvo is unable to process the request due to an internal system issue or to an unsupported response from an institution"

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"