Sign in

v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB
Onboarding

Registro de entidades

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

post/natural-person/payroll-loan-borrower

Request body

workflowConfigurationIdstring

Identificador da configuração de workflow de cedente para o determinado parceiro externo

namestring

Nome do cedente

identificationstring

CPF ou CNPJ

birthDatestring date

Data de nascimento ou fundação

phoneNumberstring

Número de telefone

phoneNumberType'PESSOAL' | 'COMERCIAL' | 'RESIDENCIAL' | 'OUTROS'

Tipo do número de telefone

emailAddressstring

Endereço de e-mail

emailAddressType'PARTICULAR' | 'COMERCIAL' | 'OUTROS'

Tipo do endereço de e-mail

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.

Example request

{
  "workflowConfigurationId": "AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE",
  "name": "Old John",
  "identification": "15996430000182",
  "phoneNumber": "+55 (11) 99999-0000",
  "phoneNumberType": "COMERCIAL",
  "emailAddress": "oldjohn@btgpactual.com",
  "emailAddressType": "PARTICULAR",
  "addresses": [
    {
      "countryCode": "BR",
      "countryName": "Brazil",
      "stateCode": "SP",
      "stateName": "São Paulo",
      "cityName": "São Paulo",
      "zipCode": "04538133",
      "street": "Av. Brg. Faria Lima",
      "number": "777",
      "complement": "19º andar",
      "type": "RESIDENCIAL",
      "neighborhood": "Itaim Bibi"
    }
  ],
  "documents": [
    {
      "identificationNumber": "15996430000182",
      "files": [
        {
          "name": "cnh.pdf",
          "key": "8102368d-672c-4f31-ab51-c17c07fac001",
          "extension": "pdf",
          "url": "https://pme-files-uat.s3.sa-east-1.amazonaws.com/8102368d-672c-4f31-ab51-c17c07fac001"
        }
      ]
    }
  ],
  "spouse": {
    "identification": "00000000000",
    "name": "Izaura Gouveia",
    "document": {
      "identificationNumber": "00000000000",
      "files": [
        {
          "name": "cnhConjuge.jpeg",
          "key": "8102368d-672c-4f31-ab51-c17c07fac001",
          "extension": "pdf",
          "url": "https://pme-files-uat.s3.sa-east-1.amazonaws.com/8102368d-672c-4f31-ab51-c17c07fac001"
        }
      ]
    }
  },
  "maritalStatus": "SOLTEIRO",
  "propertyRegime": "COMUNHAO_TOTAL",
  "integrationType": "CEDENTE_SIMPLES",
  "legalPersonality": "PF"
}

Response

Sucesso

messagestring

Mesagem de sucesso

Example response

{
  "message": "Request received"
}