---
title: "Registro de entidades"
method: POST
path: "/simple-party/natural-person"
tags: ["Onboarding"]
---

# Registro de entidades

`POST /simple-party/natural-person`

## Request

- Base URL: `https://api.sandbox.empresas.btgpactual.com`
- URL: `https://api.sandbox.empresas.btgpactual.com/simple-party/natural-person`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://id.btgpactual.com/oauth2/token` scopes: `empresas.btgpactual.com/payer-register`

Criação de um processo de registro, validação, fraudes e compliance  de entidade nos sistemas internos do BTG.

## Request body

- object
  - `workflowConfigurationId` string: Identificador da configuração de workflow de cedente para o determinado parceiro externo
  - `name` string: Nome do cedente
  - `identification` string: CPF ou CNPJ
  - `birthDate` string, date: Data de nascimento ou fundação
  - `phoneNumber` string: Número de telefone
  - `phoneNumberType` 'PESSOAL' | 'COMERCIAL' | 'RESIDENCIAL' | 'OUTROS': Tipo do número de telefone
  - `emailAddress` string: Endereço de e-mail
  - `emailAddressType` 'PARTICULAR' | 'COMERCIAL' | 'OUTROS': Tipo do endereço de e-mail
  - `addresses` object[]: Informações de endereço
    - `countryCode` string
    - `countryName` string
    - `stateCode` string
    - `stateName` string
    - `cityName` string
    - `zipCode` string
    - `street` string
    - `number` string
    - `complement` string
    - `type` 'INDEFINIDO' | 'RESIDENCIAL' | 'COMERCIAL' | 'OUTROS' | 'NATURALIDADE'
    - `neighborhood` string
  - `documents` object[]: Informações de documentos
    - `type` 'IDENTIFICACAO' | 'BIOMETRIA' | 'CONTRATO_SOCIAL' | 'ATA_ELEICAO'
    - `subtype` 'CNH' | 'SELFIE', nullable: O subtipo só é necessário quando o tipo for identidade.
    - `identificationNumber` string, nullable: Número de identidade, como o número do RG, CPF ou CNH.
    - `files` object[]
      - `name` string: Nome do arquivo
      - `key` string, nullable: Chave do arquivo enviado (opcional)
      - `extension` 'pdf' | 'jpg' | 'jpeg' | 'docx' | 'doc' | 'png' | 'jfif' | 'ai': Extensão do arquivo
      - `url` string: URL do arquivo enviado
      - `pageType` 'MULTI_PAGINAS' | 'FRENTE' | 'VERSO' | 'COMPLETO': Orientação do tipo de paginação do arquivo
  - `spouse` object, nullable
    - `identification` string: Identificação do cônjuge, como CPF ou RG (em casos de cedente PF).
    - `name` string: Nome do cônjuge
    - `document` object
      - `type` 'IDENTIFICACAO' | 'COMPROVANTE_DE_RESIDENCIA' | 'INDEFINIDO' | 'BIOMETRIA' | 'CERTIDAO_DE_CASAMENTO': Documento do cônjuge
      - `subType` 'INDEFINIDO' | 'CNH' | 'RG' | 'RNE' | 'SELFIE' | 'PASSAPORTE' | 'RNM', nullable: Tipo específico do documento do cônjuge, caso este documento seja de identidade.
      - `identificationNumber` string: Número de identificação do cônjuge, como CPF ou RG
      - `files` object[]
        - `name` string: Nome do arquivo do cônjuge
        - `key` string, nullable: Chave do arquivo do cônjuge (opcional)
        - `extension` 'pdf' | 'jpg' | 'jpeg' | 'docx' | 'doc' | 'png' | 'jfif' | 'ai': Extensão do arquivo do cônjuge
        - `url` string: URL do arquivo enviado do cônjuge
        - `pageType` 'MULTI_PAGINAS' | 'FRENTE' | 'VERSO' | 'COMPLETO': Orientação do tipo de paginação do arquivo
  - `maritalStatus` 'INDEFINIDO' | 'CASADO' | 'DIVORCIADO' | 'SEPARADO_JUDICIALMENTE' | 'SOLTEIRO' | 'UNIAO_ESTAVEL' | 'VIUVO', nullable: Estado civil do cedente (em casos de cedente pessoa física)
  - `propertyRegime` 'INDEFINIDO' | 'COMUNHAO_PARCIAL' | 'COMUNHAO_TOTAL' | 'PARTICIPACAO_AQUESTOS' | 'SEPARACAO_TOTAL', nullable: Regime de bens do fornecedor (em casos de fornecedor PF)
  - `integrationType` 'TOMADOR_DE_CREDITO' | 'CEDENTE_COMPLETO' | 'CEDENTE_SIMPLES' | 'SACADO_SIMPLES' | 'SACADO_SIMPLES_ROLLOUT' | 'AVALISTA' | 'CONSIGNADO' | 'SPOUSE': Tipo de relacionamento (sempre CEDENTE_SIMPLES, nesse caso!).
  - `legalPersonality` 'PF' | 'PJ': Tipo de personalidade legal do fornecedor, seja pessoa física ou pessoa jurídica.

## Response `201`

Sucesso

- SucessSchema
  - `message` string: Mesagem de sucesso

## Other responses

- `400`: Erro
- `401`: Não autorizado

---

[API](https://skmtc.dev/btgpactual/apis/folha-de-pagamentos.md) - [All operations](https://skmtc.dev/btgpactual/apis/folha-de-pagamentos/llms.txt) - [OpenAPI document](https://skmtc.dev/btgpactual/apis/folha-de-pagamentos/revisions/2a24d3da114c?raw)
