> ## Documentation Index
> Fetch the complete documentation index at: https://docs.localpayment.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Criar uma entidade

Registra uma pessoa física (INDIVIDUAL) ou uma pessoa jurídica (COMPANY) com seu documento de identificação. A entidade é criada com status PENDING\_KYC e sem arquivos; envie os arquivos de apoio depois com Enviar uma Prova.

* Os dados mínimos de KYC são validados na criação: name e lastname para INDIVIDUAL, name para COMPANY. Caso contrário, a API retorna 422 INCOMPLETE\_KYC\_DATA.
* Propriedades desconhecidas são rejeitadas com 400 VALIDATION\_ERROR. Coloque quaisquer dados adicionais em attributes.
* Os códigos de país devem estar em ISO 3166-1 alpha-3 (BRA, não BR).
* Um identificador fiscal (CPF, CNPJ, CUIT, RFC, …) é um documento, não um campo da entidade. Envie-o em document; documents\[] não é aceito na criação (400 VALIDATION\_ERROR).
* Adicione os demais documentos (documento de identidade, comprovante de endereço, contrato social) com Adicionar um Documento.
* Guarde document.documentId da resposta: é o docId usado para enviar arquivos ao documento principal.

Erros usam `application/problem+json` com um `code` estável. Catálogo completo: [Status de Entidades e Códigos de Erro](https://docs.localpayment.com/pt-br/reference/entity-statuses-and-error-codes.md).


## OpenAPI

````yaml openapi/pt-br/localpayment.json POST /api/entity/v1/entities
openapi: 3.1.0
info:
  version: '1.0'
  title: Localpayment
  contact:
    name: Support
    url: mailto:support@localpayment.com
servers:
  - url: https://api.stage.localpayment.com
    description: Stage
security:
  - token: []
paths:
  /api/entity/v1/entities:
    post:
      summary: Criar uma entidade
      operationId: create-entity
      parameters:
        - name: Authorization
          in: header
          description: >-
            Token de acesso Bearer para autenticação. Este token é obtido nos
            endpoints [Obter token de acesso](/pt-br/reference/get-token) ou
            [Renovar token de acesso](/pt-br/reference/refresh-token). Sua conta
            de comerciante e o usuário que realiza a ação são identificados a
            partir dele.
          required: true
          schema:
            type: string
            examples:
              - Bearer <your_access_token>
        - name: X-Correlation-ID
          in: header
          description: >-
            Identificador de rastreamento (UUID). Exibido na resposta; gerado
            pelo Localpayment se ausente.
          required: false
          schema:
            type: string
            examples:
              - 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                externalId:
                  type: string
                  description: >-
                    Seu próprio identificador para a entidade. Único para cada
                    comerciante, de 1 a 64 caracteres.
                  examples:
                    - f47ac10b-58cc-4372-a567-0e02b2c3d479
                type:
                  type: string
                  description: PESSOA FÍSICA ou EMPRESA (pessoa jurídica).
                  enum:
                    - INDIVIDUAL
                    - COMPANY
                  examples:
                    - COMPANY
                name:
                  type: string
                  description: >-
                    Nome (PESSOA FÍSICA) ou razão social (EMPRESA). Até 255
                    caracteres.
                  examples:
                    - Example Company S.A.
                lastname:
                  type: string
                  description: Sobrenome. Obrigatório para INDIVIDUAL. Até 255 caracteres.
                  examples:
                    - Doe
                birthdate:
                  type: string
                  format: date
                  description: AAAA-MM-DD. Recomendado para uso INDIVIDUAL.
                  examples:
                    - '1990-01-15'
                gender:
                  type: string
                  description: MALE, FEMALE, OTHER ou UNDISCLOSED.
                  enum:
                    - MALE
                    - FEMALE
                    - OTHER
                    - UNDISCLOSED
                  examples:
                    - FEMALE
                nationality:
                  type: string
                  description: ISO 3166-1 alpha-3 (BRA, ARG, MEX).
                  examples:
                    - BRA
                birthCountry:
                  type: string
                  description: ISO 3166-1 alfa-3.
                  examples:
                    - BRA
                residenceCountry:
                  type: string
                  description: >-
                    ISO 3166-1 alfa-3. Para uma EMPRESA, país de residência
                    fiscal.
                  examples:
                    - BRA
                occupation:
                  type: string
                  description: Profissão da pessoa. Até 100 caracteres.
                  examples:
                    - Engineer
                isPep:
                  type: boolean
                  description: 'Pessoa politicamente exposta. Valor padrão: falso.'
                  examples:
                    - false
                incorporationDate:
                  type: string
                  format: date
                  description: AAAA-MM-DD. Somente para empresas.
                  examples:
                    - '2020-01-15'
                incorporationCountry:
                  type: string
                  description: ISO 3166-1 alfa-3. Somente para empresas.
                  examples:
                    - BRA
                website:
                  type: string
                  description: Site da empresa. Até 255 caracteres.
                  examples:
                    - https://www.example.com
                legalRepresentativeName:
                  type: string
                  description: Nome do representante legal (COMPANY). Até 255 caracteres.
                  examples:
                    - Jane Doe
                email:
                  type: string
                  description: E-mail para contato. Até 255 caracteres.
                  examples:
                    - test@example.com
                phone:
                  type: object
                  description: Telefone para contato, somente dígitos em cada parte.
                  properties:
                    countryCode:
                      type: string
                      description: Código de discagem do país sem + (55), de 1 a 4 dígitos.
                      examples:
                        - '55'
                    areaCode:
                      type: string
                      description: Código de área (11), de 1 a 5 dígitos.
                      examples:
                        - '11'
                    number:
                      type: string
                      description: >-
                        Número local (999990001), de 4 a 15 dígitos. Obrigatório
                        quando phone é enviado.
                      examples:
                        - '999990000'
                address:
                  type: object
                  description: Endereço postal. Ao enviar, é necessário informar o país.
                  properties:
                    street:
                      type: string
                      description: Nome da rua, até 256 caracteres.
                      examples:
                        - Rua Exemplo
                    number:
                      type: string
                      description: Número da rua, até 20 caracteres.
                      examples:
                        - '100'
                    line2:
                      type: string
                      description: >-
                        Linha adicional do endereço (apartamento, andar, sala),
                        até 256 caracteres.
                      examples:
                        - Sala 100
                    line3:
                      type: string
                      description: >-
                        Segunda linha adicional de endereço, com até 256
                        caracteres.
                      examples:
                        - Torre A
                    city:
                      type: string
                      description: Cidade, até 100 caracteres.
                      examples:
                        - São Paulo
                    state:
                      type: string
                      description: >-
                        Estado ou província, até 100 caracteres. Use o código
                        ISO 3166-2 (SP).
                      examples:
                        - SP
                    zipCode:
                      type: string
                      description: Código postal, com até 20 caracteres.
                      examples:
                        - 01310-100
                    country:
                      type: string
                      description: >-
                        ISO 3166-1 alpha-3. Obrigatório quando address é
                        enviado.
                      examples:
                        - BRA
                    comment:
                      type: string
                      description: >-
                        Informações adicionais do endereço (andar, apartamento,
                        referências), até 255 caracteres.
                      examples:
                        - Sala 100
                attributes:
                  type: object
                  description: >-
                    Campos personalizados definidos pelo seu esquema de campos
                    personalizados (consulte Campos Personalizados). Até 64 KB.
                document:
                  type: object
                  description: >-
                    O documento de identificação da entidade (número de
                    identificação fiscal ou documento de identidade). Ele se
                    torna o documento principal. Outros documentos são
                    adicionados posteriormente através da opção "Adicionar um
                    documento".
                  properties:
                    type:
                      type: string
                      description: Consulte Tipos de Documentos e Provas.
                      enum:
                        - DNI
                        - NATIONAL_ID
                        - DRIVER_LICENSE
                        - PASSPORT
                        - CE
                        - CC
                        - CUIT
                        - CUIL
                        - RFC
                        - CURP
                        - CPF
                        - CNPJ
                        - RUC
                        - NIT
                        - TAX_ID
                        - ARTICLES_OF_INCORPORATION
                        - POWER_OF_ATTORNEY
                        - TAX_CERTIFICATE
                        - PAYSLIP
                        - ARCA_REGISTRATION
                        - PROOF_OF_ADDRESS
                        - PROOF_OF_FUNDS
                        - OTHER
                      examples:
                        - CNPJ
                    id:
                      type: string
                      description: >-
                        Número do documento conforme emitido, de 1 a 30
                        caracteres. Único em conjunto com o tipo no seu
                        merchant.
                      examples:
                        - '00000000000100'
                    issuingCountry:
                      type: string
                      description: ISO 3166-1 alfa-3.
                      examples:
                        - BRA
                    issueDate:
                      type: string
                      format: date
                      description: AAAA-MM-DD.
                      examples:
                        - '2024-01-15'
                    expirationDate:
                      type: string
                      format: date
                      description: >-
                        AAAA-MM-DD. Uma data passada marca o documento como
                        EXPIRED.
                      examples:
                        - '2034-01-15'
                    metadata:
                      type: object
                      description: Metadados livres para o documento.
                  required:
                    - type
                    - id
              required:
                - externalId
                - type
                - name
                - document
            examples:
              Example 1 - INDIVIDUAL:
                value:
                  externalId: 550e8400-e29b-41d4-a716-446655440000
                  type: INDIVIDUAL
                  name: Jane
                  lastname: Doe
                  birthdate: '1990-01-15'
                  nationality: BRA
                  birthCountry: BRA
                  residenceCountry: BRA
                  isPep: false
                  email: jane.doe@example.com
                  phone:
                    countryCode: '55'
                    areaCode: '11'
                    number: '999990001'
                  address:
                    street: Rua Exemplo
                    number: '123'
                    city: São Paulo
                    state: SP
                    zipCode: 01310-100
                    country: BRA
                  document:
                    type: CPF
                    id: '00000000000'
                    issuingCountry: BRA
              Example 2 - COMPANY example:
                value:
                  externalId: f47ac10b-58cc-4372-a567-0e02b2c3d479
                  type: COMPANY
                  name: Example Company S.A.
                  incorporationCountry: BRA
                  incorporationDate: '2020-01-15'
                  website: https://www.example.com
                  email: test@example.com
                  phone:
                    countryCode: '55'
                    areaCode: '11'
                    number: '999990000'
                  legalRepresentativeName: Jane Doe
                  isPep: false
                  address:
                    street: Rua Exemplo
                    number: '100'
                    city: São Paulo
                    state: SP
                    zipCode: 01310-100
                    country: BRA
                    line2: Sala 100
                    line3: Torre A
                  document:
                    type: CNPJ
                    id: '00000000000100'
                    issuingCountry: BRA
                  attributes:
                    reasonForAccountOpening: receive_payments_for_goods_and_services
                    sourceOfFundsAndIncome: sales_of_goods_and_services
                    numberOfEmployees: 11-50
                    estimatedAnnualRevenueUsd: 1m_to_10m
                    estimatedMonthlyVolumeUsd: '50000'
                    businessActivityDescription: >-
                      Online retail of home goods. Receives payments from end
                      customers in Brazil via PIX.
                    countryTaxResidence: BRA
                    socialMedia: https://www.linkedin.com/company/example
                    emailPixKey: test@example.com
      responses:
        '201':
          description: Criado.
          content:
            application/json:
              schema:
                type: object
                properties:
                  internalId:
                    type: string
                    examples:
                      - 5aced5da-40c1-4bec-85ff-c8cd1bcb4526
                    format: uuid
                    description: >-
                      Identificador da entidade na Localpayment. Use-o em todos
                      os outros endpoints de Entities.
                  externalId:
                    type: string
                    examples:
                      - 550e8400-e29b-41d4-a716-446655440000
                    description: Seu identificador, conforme enviado.
                  type:
                    type: string
                    examples:
                      - INDIVIDUAL
                    enum:
                      - INDIVIDUAL
                      - COMPANY
                    description: PESSOA FÍSICA ou EMPRESA.
                  status:
                    type: string
                    examples:
                      - PENDING_KYC
                    enum:
                      - PENDING_KYC
                      - IN_REVIEW
                      - ACTIVE
                      - REJECTED
                      - BLOCKED
                      - CLOSED
                    description: >-
                      Status da entidade. Consulte Status da entidade e Códigos
                      de erro.
                  name:
                    type: string
                    examples:
                      - Jane
                  lastname:
                    type: string
                    examples:
                      - Doe
                  birthdate:
                    type: string
                    examples:
                      - '1990-01-15'
                    format: date
                  gender:
                    type:
                      - string
                      - 'null'
                  nationality:
                    type: string
                    examples:
                      - BRA
                  birthCountry:
                    type: string
                    examples:
                      - BRA
                  residenceCountry:
                    type: string
                    examples:
                      - BRA
                  occupation:
                    type:
                      - string
                      - 'null'
                  isPep:
                    type: boolean
                    examples:
                      - false
                  incorporationDate:
                    type:
                      - string
                      - 'null'
                    format: date
                  incorporationCountry:
                    type:
                      - string
                      - 'null'
                  website:
                    type:
                      - string
                      - 'null'
                  legalRepresentativeName:
                    type:
                      - string
                      - 'null'
                  email:
                    type: string
                    examples:
                      - jane.doe@example.com
                  phone:
                    type: object
                    properties:
                      countryCode:
                        type: string
                        examples:
                          - '55'
                      areaCode:
                        type: string
                        examples:
                          - '11'
                      number:
                        type: string
                        examples:
                          - '999990001'
                  address:
                    type: object
                    properties:
                      street:
                        type: string
                        examples:
                          - Rua Exemplo
                      city:
                        type: string
                        examples:
                          - São Paulo
                      state:
                        type: string
                        examples:
                          - SP
                      zipCode:
                        type: string
                        examples:
                          - 01310-100
                      number:
                        type: string
                        examples:
                          - '123'
                      comment:
                        type:
                          - string
                          - 'null'
                      country:
                        type: string
                        examples:
                          - BRA
                      line2:
                        type:
                          - string
                          - 'null'
                      line3:
                        type:
                          - string
                          - 'null'
                  attributes:
                    type:
                      - object
                      - 'null'
                  documentationStatus:
                    type: string
                    examples:
                      - NO_FILES
                    enum:
                      - NO_FILES
                      - PARTIAL
                      - COMPLETE
                    description: >-
                      NO_FILES, PARTIAL ou COMPLETE: indica se nenhum, alguns ou
                      todos os documentos declarados possuem pelo menos um
                      arquivo. Mede a presença de arquivos, não a aprovação.
                  document:
                    type: object
                    properties:
                      documentId:
                        type: string
                        examples:
                          - 2e16d844-4fa9-4295-9a21-83ec32ef241a
                        format: uuid
                      entityId:
                        type: string
                        examples:
                          - 5aced5da-40c1-4bec-85ff-c8cd1bcb4526
                        format: uuid
                      type:
                        type: string
                        examples:
                          - CPF
                        enum:
                          - DNI
                          - NATIONAL_ID
                          - DRIVER_LICENSE
                          - PASSPORT
                          - CE
                          - CC
                          - CUIT
                          - CUIL
                          - RFC
                          - CURP
                          - CPF
                          - CNPJ
                          - RUC
                          - NIT
                          - TAX_ID
                          - ARTICLES_OF_INCORPORATION
                          - POWER_OF_ATTORNEY
                          - TAX_CERTIFICATE
                          - PAYSLIP
                          - ARCA_REGISTRATION
                          - PROOF_OF_ADDRESS
                          - PROOF_OF_FUNDS
                          - OTHER
                        description: PESSOA FÍSICA ou EMPRESA.
                      id:
                        type: string
                        examples:
                          - '00000000000'
                      issuingCountry:
                        type: string
                        examples:
                          - BRA
                      issueDate:
                        type:
                          - string
                          - 'null'
                        format: date
                      expirationDate:
                        type:
                          - string
                          - 'null'
                        format: date
                      isPrimary:
                        type: boolean
                        examples:
                          - true
                      status:
                        type: string
                        examples:
                          - PENDING
                        enum:
                          - PENDING
                          - VERIFIED
                          - REJECTED
                          - EXPIRED
                        description: >-
                          Status derivado do documento: EXPIRED se a
                          expirationDate tiver passado, REJECTED se alguma prova
                          ativa for rejeitada, VERIFIED se todas as provas
                          ativas forem aprovadas, caso contrário PENDING.
                      metadata:
                        type:
                          - object
                          - 'null'
                      proofs:
                        type: array
                        items:
                          type: object
                      createdAt:
                        type: string
                        examples:
                          - '2024-01-15T17:03:10Z'
                        format: date-time
                        description: Carimbos de data/hora UTC ISO 8601.
                      updatedAt:
                        type: string
                        examples:
                          - '2024-01-15T17:03:10Z'
                        format: date-time
                        description: Carimbos de data/hora UTC ISO 8601.
                    description: >-
                      O documento principal com seu documentId (necessário para
                      enviar arquivos), o status derivado e as proofs[] atuais.
                  documents:
                    type: array
                    items:
                      type: object
                    description: >-
                      Os demais documentos declarados (o principal está apenas
                      em document), com a mesma estrutura.
                  version:
                    type: integer
                    examples:
                      - 0
                    description: >-
                      Versão da entidade. Igual ao cabeçalho ETag; envie-o de
                      volta como If-Match no PATCH.
                  createdAt:
                    type: string
                    examples:
                      - '2024-01-15T17:03:10Z'
                    format: date-time
                    description: Carimbos de data/hora UTC ISO 8601.
                  updatedAt:
                    type: string
                    examples:
                      - '2024-01-15T17:03:10Z'
                    format: date-time
                    description: Carimbos de data/hora UTC ISO 8601.
                  customFieldSchemaVersion:
                    type:
                      - integer
                      - 'null'
                    description: >-
                      Versão do esquema de campos personalizados usado para
                      validar atributos, ou nulo.
              examples:
                Example 1:
                  value:
                    internalId: 5aced5da-40c1-4bec-85ff-c8cd1bcb4526
                    externalId: 550e8400-e29b-41d4-a716-446655440000
                    type: INDIVIDUAL
                    status: PENDING_KYC
                    name: Jane
                    lastname: Doe
                    birthdate: '1990-01-15'
                    gender: null
                    nationality: BRA
                    birthCountry: BRA
                    residenceCountry: BRA
                    occupation: null
                    isPep: false
                    incorporationDate: null
                    incorporationCountry: null
                    website: null
                    legalRepresentativeName: null
                    email: jane.doe@example.com
                    phone:
                      countryCode: '55'
                      areaCode: '11'
                      number: '999990001'
                    address:
                      street: Rua Exemplo
                      city: São Paulo
                      state: SP
                      zipCode: 01310-100
                      number: '123'
                      comment: null
                      country: BRA
                      line2: null
                      line3: null
                    attributes: null
                    documentationStatus: NO_FILES
                    document:
                      documentId: 2e16d844-4fa9-4295-9a21-83ec32ef241a
                      entityId: 5aced5da-40c1-4bec-85ff-c8cd1bcb4526
                      type: CPF
                      id: '00000000000'
                      issuingCountry: BRA
                      issueDate: null
                      expirationDate: null
                      isPrimary: true
                      status: PENDING
                      metadata: null
                      proofs: []
                      createdAt: '2024-01-15T17:03:10Z'
                      updatedAt: '2024-01-15T17:03:10Z'
                    documents: []
                    version: 0
                    createdAt: '2024-01-15T17:03:10Z'
                    updatedAt: '2024-01-15T17:03:10Z'
                    customFieldSchemaVersion: null
          headers:
            ETag:
              description: >-
                Versão da entidade. Envie-a de volta como If-Match em Update an
                Entity.
              schema:
                type: string
                examples:
                  - '"0"'
        '400':
          description: >-
            Solicitação inválida. VALIDATION_ERROR: Um campo, cabeçalho, caminho
            ou parâmetro de consulta está ausente, é desconhecido ou inválido.
            details[] lista o campo e o problema. CUSTOM_FIELDS_INVALID: os
            atributos não atendem ao seu esquema de campos personalizados.
            details[] lista o campo e o problema.
          content:
            application/problem+json:
              schema:
                type: object
                description: >-
                  Detalhes do problema segundo a RFC 9457
                  (application/problem+json).
                properties:
                  type:
                    type: string
                    examples:
                      - about:blank
                  title:
                    type: string
                    description: Breve resumo do problema.
                  status:
                    type: integer
                    description: Código de status HTTP.
                  detail:
                    type: string
                    description: Explicação em linguagem acessível a humanos.
                  instance:
                    type: string
                    description: Caminho da solicitação.
                  code:
                    type: string
                    description: >-
                      Código de erro estável e legível por máquina. Faça a
                      ramificação da lógica com base nesse valor.
                  correlationId:
                    type: string
                    format: uuid
                    description: >-
                      Identificador da solicitação. Informe-o ao entrar em
                      contato com o suporte.
                    examples:
                      - 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                  details:
                    type: array
                    description: Campos problemáticos, quando aplicável.
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                          examples:
                            - numberOfEmployees
                        issue:
                          type: string
                          examples:
                            - NOT_IN_OPTIONS
              examples:
                Example 1 - VALIDATION_ERROR:
                  value:
                    type: about:blank
                    title: Validation error
                    status: 400
                    detail: >-
                      A field, header, path or query parameter is missing,
                      unknown or invalid. details[] lists field and issue.
                    instance: /api/entity/v1/entities
                    code: VALIDATION_ERROR
                    correlationId: 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                    details:
                      - field: externalId
                        issue: REQUIRED
                Example 2 - CUSTOM_FIELDS_INVALID:
                  value:
                    type: about:blank
                    title: Validation error
                    status: 400
                    detail: >-
                      attributes does not satisfy your custom-fields schema.
                      details[] lists field and issue.
                    instance: /api/entity/v1/entities
                    code: CUSTOM_FIELDS_INVALID
                    correlationId: 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                    details:
                      - field: numberOfEmployees
                        issue: NOT_IN_OPTIONS
        '401':
          description: 'Não autorizado. UNAUTHORIZED: Token de acesso ausente ou inválido.'
          content:
            application/problem+json:
              schema:
                type: object
                description: >-
                  Detalhes do problema segundo a RFC 9457
                  (application/problem+json).
                properties:
                  type:
                    type: string
                    examples:
                      - about:blank
                  title:
                    type: string
                    description: Breve resumo do problema.
                  status:
                    type: integer
                    description: Código de status HTTP.
                  detail:
                    type: string
                    description: Explicação em linguagem acessível a humanos.
                  instance:
                    type: string
                    description: Caminho da solicitação.
                  code:
                    type: string
                    description: >-
                      Código de erro estável e legível por máquina. Faça a
                      ramificação da lógica com base nesse valor.
                  correlationId:
                    type: string
                    format: uuid
                    description: >-
                      Identificador da solicitação. Informe-o ao entrar em
                      contato com o suporte.
                    examples:
                      - 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                  details:
                    type: array
                    description: Campos problemáticos, quando aplicável.
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                          examples:
                            - numberOfEmployees
                        issue:
                          type: string
                          examples:
                            - NOT_IN_OPTIONS
              examples:
                Example 1 - UNAUTHORIZED:
                  value:
                    type: about:blank
                    title: Unauthorized
                    status: 401
                    detail: Missing or invalid access token.
                    instance: /api/entity/v1/entities
                    code: UNAUTHORIZED
                    correlationId: 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                    details: []
        '409':
          description: >-
            Conflito. DUPLICATE_ENTITY: externalId, ou o par tipo + id de um
            documento, já existe em seu cadastro de comerciante.
          content:
            application/problem+json:
              schema:
                type: object
                description: >-
                  Detalhes do problema segundo a RFC 9457
                  (application/problem+json).
                properties:
                  type:
                    type: string
                    examples:
                      - about:blank
                  title:
                    type: string
                    description: Breve resumo do problema.
                  status:
                    type: integer
                    description: Código de status HTTP.
                  detail:
                    type: string
                    description: Explicação em linguagem acessível a humanos.
                  instance:
                    type: string
                    description: Caminho da solicitação.
                  code:
                    type: string
                    description: >-
                      Código de erro estável e legível por máquina. Faça a
                      ramificação da lógica com base nesse valor.
                  correlationId:
                    type: string
                    format: uuid
                    description: >-
                      Identificador da solicitação. Informe-o ao entrar em
                      contato com o suporte.
                    examples:
                      - 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                  details:
                    type: array
                    description: Campos problemáticos, quando aplicável.
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                          examples:
                            - numberOfEmployees
                        issue:
                          type: string
                          examples:
                            - NOT_IN_OPTIONS
              examples:
                Example 1 - DUPLICATE_ENTITY:
                  value:
                    type: about:blank
                    title: Conflict
                    status: 409
                    detail: >-
                      externalId, or the pair type + id of a document, already
                      exists in your merchant.
                    instance: /api/entity/v1/entities
                    code: DUPLICATE_ENTITY
                    correlationId: 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                    details: []
        '413':
          description: >-
            Carga útil muito grande. PAYLOAD_TOO_LARGE: os atributos excedem 64
            KB.
          content:
            application/problem+json:
              schema:
                type: object
                description: >-
                  Detalhes do problema segundo a RFC 9457
                  (application/problem+json).
                properties:
                  type:
                    type: string
                    examples:
                      - about:blank
                  title:
                    type: string
                    description: Breve resumo do problema.
                  status:
                    type: integer
                    description: Código de status HTTP.
                  detail:
                    type: string
                    description: Explicação em linguagem acessível a humanos.
                  instance:
                    type: string
                    description: Caminho da solicitação.
                  code:
                    type: string
                    description: >-
                      Código de erro estável e legível por máquina. Faça a
                      ramificação da lógica com base nesse valor.
                  correlationId:
                    type: string
                    format: uuid
                    description: >-
                      Identificador da solicitação. Informe-o ao entrar em
                      contato com o suporte.
                    examples:
                      - 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                  details:
                    type: array
                    description: Campos problemáticos, quando aplicável.
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                          examples:
                            - numberOfEmployees
                        issue:
                          type: string
                          examples:
                            - NOT_IN_OPTIONS
              examples:
                Example 1 - PAYLOAD_TOO_LARGE:
                  value:
                    type: about:blank
                    title: Payload too large
                    status: 413
                    detail: attributes exceeds 64 KB.
                    instance: /api/entity/v1/entities
                    code: PAYLOAD_TOO_LARGE
                    correlationId: 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                    details: []
        '415':
          description: >-
            Tipo de mídia não suportado. UNSUPPORTED_MEDIA_TYPE: O Content-Type
            da solicitação não é o esperado pelo endpoint (application/json ou
            multipart/form-data para uploads).
          content:
            application/problem+json:
              schema:
                type: object
                description: >-
                  Detalhes do problema segundo a RFC 9457
                  (application/problem+json).
                properties:
                  type:
                    type: string
                    examples:
                      - about:blank
                  title:
                    type: string
                    description: Breve resumo do problema.
                  status:
                    type: integer
                    description: Código de status HTTP.
                  detail:
                    type: string
                    description: Explicação em linguagem acessível a humanos.
                  instance:
                    type: string
                    description: Caminho da solicitação.
                  code:
                    type: string
                    description: >-
                      Código de erro estável e legível por máquina. Faça a
                      ramificação da lógica com base nesse valor.
                  correlationId:
                    type: string
                    format: uuid
                    description: >-
                      Identificador da solicitação. Informe-o ao entrar em
                      contato com o suporte.
                    examples:
                      - 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                  details:
                    type: array
                    description: Campos problemáticos, quando aplicável.
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                          examples:
                            - numberOfEmployees
                        issue:
                          type: string
                          examples:
                            - NOT_IN_OPTIONS
              examples:
                Example 1 - UNSUPPORTED_MEDIA_TYPE:
                  value:
                    type: about:blank
                    title: Unsupported media type
                    status: 415
                    detail: >-
                      The request Content-Type is not the one the endpoint
                      expects (application/json, or multipart/form-data for
                      uploads).
                    instance: /api/entity/v1/entities
                    code: UNSUPPORTED_MEDIA_TYPE
                    correlationId: 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                    details: []
        '422':
          description: >-
            Entidade não processável. INCOMPLETE_KYC_DATA: Os dados mínimos de
            KYC estão ausentes: name e lastname para INDIVIDUAL, name para
            COMPANY.
          content:
            application/problem+json:
              schema:
                type: object
                description: >-
                  Detalhes do problema segundo a RFC 9457
                  (application/problem+json).
                properties:
                  type:
                    type: string
                    examples:
                      - about:blank
                  title:
                    type: string
                    description: Breve resumo do problema.
                  status:
                    type: integer
                    description: Código de status HTTP.
                  detail:
                    type: string
                    description: Explicação em linguagem acessível a humanos.
                  instance:
                    type: string
                    description: Caminho da solicitação.
                  code:
                    type: string
                    description: >-
                      Código de erro estável e legível por máquina. Faça a
                      ramificação da lógica com base nesse valor.
                  correlationId:
                    type: string
                    format: uuid
                    description: >-
                      Identificador da solicitação. Informe-o ao entrar em
                      contato com o suporte.
                    examples:
                      - 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                  details:
                    type: array
                    description: Campos problemáticos, quando aplicável.
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                          examples:
                            - numberOfEmployees
                        issue:
                          type: string
                          examples:
                            - NOT_IN_OPTIONS
              examples:
                Example 1 - INCOMPLETE_KYC_DATA:
                  value:
                    type: about:blank
                    title: Unprocessable entity
                    status: 422
                    detail: >-
                      Minimum KYC data is missing: name and lastname for
                      INDIVIDUAL, name for COMPANY.
                    instance: /api/entity/v1/entities
                    code: INCOMPLETE_KYC_DATA
                    correlationId: 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                    details: []
      security:
        - token: []
components:
  securitySchemes:
    token:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.