Pessoas

Criar uma pessoa do tipo "jurídica"

Esse endpoint deve ser utilizado para cadastrar uma Pessoa do tipo jurídica, usando um nº de CNPJ como identificador.

Parâmetros do Body

  • name (string, obrigatório): A razão social associada ao CNPJ em cadastro.

  • personType (string, obrigatório): O tipo da pessoa, informar o valor "LEGAL" para cadastrar uma pessoa juridica. Possíveis valores: NATURAL, LEGAL.

  • taxpayerId (string, obrigatório): O número do CNPJ de registro da empresa na Receita Federal.

  • documents (object, obrigatório): Objeto contendo as 'keys' das URLs 'pre-signed' do documento de contrato social (documentIdentification) e comprovante de endereço (proofOfAddress).

  • idDocument (object, obrigatório): Objeto para detalhar o documento de identificação que esta sendo enviado.

    • issueDate (string, obrigatório): Data de emissão do documento.

    • issuer (string, obrigatório): Orgão responsável pela emissão do documento.

    • number (string, obrigatório): Número do documento.

    • type (string, obrigatório): Tipo do documento. Valores aceitos: CNH, PASSPORT, RG, RNE.

  • birthDate (string, obrigatório): Data de abertura da empresa no formato "AAAA-MM-DD".

  • emailAddress (string, obrigatório): Endereço de e-mail para contato com a empresa cadastrada.

  • phone (object, obrigatório): Objeto contendo os dados do telefone de contato.

    • countryCode (string): Código do país.

    • areaCode (string): Código de área.

    • number (string): Número do telefone.

  • address (object, obrigatório): Objeto contendo detalhes do endereço de cadastro.

    • streetNumber (string): Número do endereço informado.

    • streetName (string): Nome da rua.

    • postalCode (string): Código de CEP para o endereço.

    • district (string): Campo para informar o bairro.

    • city (string): Nome da cidade.

    • stateCode (string): Código da UF para o estado do endereço.

    • countryCode (string): Código do país.

    • extraInfo (string): Complemento do endereço.

  • fundManagerId (string/uuid v4): ID do gestor do Fundo, se aplicável.

  • fundSecuritizerId (string/uuid v4): ID da securitizadora do Fundo, se aplicável.

  • fundAdministratorId (string/uuid v4): ID do Admnistrador do Fundo, se aplicável.

  • representatives (object): Objeto contendo os detalhes dos representantes da empresa. Deve ser enviado obrigatoriamente quando o tipo da Pessoa for jurídica (LEGAL).

Objeto "representatives"
  • role (string, obrigatório): O tipo do relacionamento. Valores aceitos: PARTNER, MANAGER, PROXY, OTHER, EMPLOYEE.

  • taxpayerId (string, obrigatório): O número do documento CPF para identificação da Pessoa.

  • fullName (string, obrigatório): Nome do representante.

  • documents (object): Objeto contendo as 'keys' das URLs 'pre-signed' dos documentos de identificação (documentIdentification) e comprovante de endereço (proofOfAddress).

  • idDocument (object, obrigatório): Objeto para detalhar o documento de identificação que esta sendo enviado.

    • issueDate (string, obrigatório): Data de emissão do documento.

    • issuer (string, obrigatório): Orgão responsável pela emissão do documento.

    • number (string, obrigatório): Número do documento.

    • type (string, obrigatório): Tipo do documento. Valores aceitos: CNH, PASSPORT, RG, RNE.

  • birthDate (string): Data de nascimento no formato "AAAA-MM-DD".

  • motherName (string, obrigatório): Nome da mãe.

  • pep (boolean, obrigatório): Campo para indica se a pessoa é politicamente exposta.

  • signContract (boolean, obrigatório): Indica se a pessoa é representante e pode assinar pela Empresa.

  • emailAddress (string, obrigatório): Endereço de e-mail para contato com a pessoa cadastrada.

  • phone (object): Objeto contendo os dados do telefone de contato.

    • countryCode (string): Código do país no formato "+99".

    • areaCode (string): Código de área.

    • number (string): Número do telefone.

  • address (object): Objeto contendo detalhes do endereço de cadastro.

    • streetNumber (string): Número do endereço informado.

    • streetName (string): Nome da rua.

    • postalCode (string): Código de CEP para o endereço.

    • district (string): Campo para informar o bairro.

    • city (string): Nome da cidade.

    • stateCode (string): Código da UF para o estado do endereço.

    • countryCode (string): Código do país.

    • extraInfo (string): Complemento do endereço.

Resposta

A resposta da requisição será um JSON representando o retorno obtido para os campos enviados.

Em caso de sucesso será retornado um status_code "200-OK". Em caso de falha será retornado um código 40x com a mensagem indicativa do erro.

  • id (string/uuid v4): ID gerado para o cadastro realizado da Pessoa Jurídica.
Exemplo de JSON:
{
    "id": ""
}

post/escrow/api/persons2

Request

  • Base URL
    https://sandbox.platform.credit.celcoin.com.br
  • URL
    https://sandbox.platform.credit.celcoin.com.br/escrow/api/persons2
  • Auth
    none declared

Headers

Content-Typestring
Acceptstring

Request body

object required

Example request

{
  "name": "(Obrigatório) Celcoin Sandbox LTDA",
  "personType": "LEGAL",
  "emailAddress": "teste@teste.com",
  "taxpayerId": "14333",
  "birthDate": "1982-08-15",
  "documents": {
    "documentIdentification": "<string>",
    "proofOfAddress": "<string>"
  },
  "phone": {
    "countryCode": "+55",
    "area_code": "11",
    "number": "999999999"
  },
  "address": {
    "streetName": "Alameda Xingu",
    "streetNumber": "350",
    "postalCode": "06455030",
    "district": "Alphaville",
    "city": "Barueri",
    "stateCode": "SP",
    "countryCode": "BRA"
  },
  "representatives": [
    {
      "role": "MANAGER",
      "taxpayerId": "34315132802",
      "fullName": "<string>",
      "motherName": "<string>",
      "emailAddress": "email@email.com",
      "birthDate": "1982-04-15",
      "phone": {
        "countryCode": "+0",
        "areaCode": "<string>",
        "number": "<string>"
      },
      "address": {
        "streetName": "<string>",
        "streetNumber": "<string>",
        "postalCode": "68036358",
        "district": "<string>",
        "city": "<string>",
        "stateCode": "SP",
        "countryCode": "+55",
        "extraInfo": "<string>"
      },
      "idDocument": {
        "type": "RG",
        "number": "<string>",
        "issuer": "<string>",
        "issueDate": "2020-02-20"
      },
      "documents": {
        "identification": "<string>",
        "proofOfAddress": "<string>"
      },
      "pep": false,
      "signContract": true
    }
  ]
}

Response

OK

object required

Changes

No recorded changes to this operation across all 1 revision of this API.