Atualização de Cadastro

Atualização de Cadastro de Cedente Pessoa Jurídica

Request

ENDPOINT

/assignor_registry/assignor_registry/ASSIGNOR_REGISTRY_KEY

MÉTODO

PUT

Request Body
{
  "name": "QI DTVM",
  "document_number": "67.987.787/0001-06",
  "person_type": "legal_person",
  "email": "qidtvm@qitech.com.br",
  "maturity_level": "factoring",
  "address": {
    "street": "Gilberto Sabino",
    "number": "215",
    "neighborhood": "Pinheiros",
    "city": "São Paulo",
    "postal_code": "05425-020",
    "uf": "SP",
    "country": "BRA"
  },
  "phone": {
    "area_code": "11",
    "number": "936360268"
  },
  "legal_person": {
    "activity_code": "11.11-1-11",
    "representatives": [
      {
        "name": "Natália Nascimento",
        "document_number": "883.512.866-80",
        "email": "natália.nascimento@yopmail.com",
        "representative_type": "attorney",
        "person_type": "natural_person",
        "address": {
          "street": "Gilberto Sabino",
          "number": "215",
          "neighborhood": "Pinheiros",
          "city": "São Paulo",
          "postal_code": "05425-020",
          "uf": "SP",
          "country": "BRA"
        },
        "phone": {
          "area_code": "11",
          "number": "36360268"
        },
        "natural_person": {
          "mother_name": "Lívia Santos",
          "birthdate": "1978-04-11"
        }
      },
      {
        "name": "Natália Nascimento",
        "document_number": "802.834.257-41",
        "email": "natália.nascimento@yopmail.com",
        "representative_type": "attorney",
        "person_type": "natural_person",
        "address": {
          "street": "Gilberto Sabino",
          "number": "215",
          "neighborhood": "Pinheiros",
          "city": "São Paulo",
          "postal_code": "05425-020",
          "uf": "SP",
          "country": "BRA"
        },
        "phone": {
          "area_code": "11",
          "number": "36360268"
        },
        "natural_person": {
          "mother_name": "Lívia Santos",
          "birthdate": "1978-04-11"
        }
      }
    ]
  }
}

Definição do Cedente

Campo	Tipo	Descrição	Caracteres
`name` *	string	Nome do cedente.	1 a 255
`maturity_level` *	string	Nível de maturidade (risco) do cedente. Ver Níveis de Maturidade	1 a 255
`document_number` *	string	Número de documento do cedente (CNPJ).	14 a 18
`person_type` *	string	Tipo de pessoa (física ou jurídica) do cedente.	1 a 255
`email`	string	Endereço de e-mail do cedente.	1 a 255
`phone`	object	Objeto referenciando as informações do telefone do cedente. Ver Definição de Telefone.	-
`address` *	object	Objeto referenciando as informações do endereço do cedente. Ver Definição de Endereço.	-
`legal_person` *	object	Objeto referenciando as informações da pessoa jurídica do cedente. Ver Definição de Pessoa Jurídica.	-

*Campos obrigatórios.

Response

STATUS

202

Response Body
{
  "assignor_registry_key": "c4295375-4077-4092-a258-5bcdf8875907",
  "status": "pending_registry",
  "name": "QI DTVM",
  "document_number": "67.987.787/0001-06",
  "person_type": "legal_person",
  "maturity_level": "factoring",
  "email": "qidtvm@qitech.com.br",
  "phone": {
    "number": "936360268",
    "area_code": "11"
  },
  "address": {
    "uf": "SP",
    "city": "São Paulo",
    "number": "215",
    "street": "Gilberto Sabino",
    "country": "BRA",
    "postal_code": "05425-020",
    "neighborhood": "Pinheiros"
  },
  "legal_person": {
    "activity_code": "11.11-1-11",
    "representatives": []
  },
  "last_analysis": {
    "analysis_key": "d7805a05-98a7-486b-a440-807f1d3d5691",
    "analysis_number": 1,
    "assignor_registry_key": "c4295375-4077-4092-a258-5bcdf8875907",
	"status": "pending_documents",
    "analysis_data": {
      "name": "QI DTVM",
      "email": "qidtvm@qitech.com.br",
      "phone": {
        "number": "936360268",
        "area_code": "11"
      },
      "address": {
        "uf": "SP",
        "city": "São Paulo",
        "number": "215",
        "street": "Gilberto Sabino",
        "country": "BRA",
        "postal_code": "05425-020",
        "neighborhood": "Pinheiros"
      },
      "person_type": "legal_person",
      "legal_person": {
        "activity_code": "11.11-1-11",
        "representatives": [
          {
            "name": "Natália Nascimento",
            "email": "natália.nascimento@yopmail.com",
            "phone": {
              "number": "36360268",
              "area_code": "11"
            },
            "address": {
              "uf": "SP",
              "city": "São Paulo",
              "number": "215",
              "street": "Gilberto Sabino",
              "country": "BRA",
              "postal_code": "05425-020",
              "neighborhood": "Pinheiros"
            },
            "person_type": "natural_person",
            "natural_person": {
              "birthdate": "1978-04-11",
              "mother_name": "Lívia Santos"
            },
            "document_number": "883.512.866-80",
            "representative_type": "attorney"
          },
          {
            "name": "Natália Nascimento",
            "email": "natália.nascimento@yopmail.com",
            "phone": {
              "number": "36360268",
              "area_code": "11"
            },
            "address": {
              "uf": "SP",
              "city": "São Paulo",
              "number": "215",
              "street": "Gilberto Sabino",
              "country": "BRA",
              "postal_code": "05425-020",
              "neighborhood": "Pinheiros"
            },
            "person_type": "natural_person",
            "natural_person": {
              "birthdate": "1978-04-11",
              "mother_name": "Lívia Santos"
            },
            "document_number": "802.834.257-41",
            "representative_type": "attorney"
          }
        ]
      },
      "maturity_level": "factoring",
      "document_number": "67.987.787/0001-06"
    },
    "analysis_representatives": [
      {
        "analysis_representative_key": "5cdcc13b-c67d-45f3-aa66-36cb4f178b59",
        "document_number": "802.834.257-41",
        "person_data": {
          "name": "Natália Nascimento",
          "email": "natália.nascimento@yopmail.com",
          "phone": {
            "number": "36360268",
            "area_code": "11"
          },
          "address": {
            "uf": "SP",
            "city": "São Paulo",
            "number": "215",
            "street": "Gilberto Sabino",
            "country": "BRA",
            "postal_code": "05425-020",
            "neighborhood": "Pinheiros"
          },
          "person_type": "natural_person",
          "natural_person": {
            "birthdate": "1978-04-11",
            "mother_name": "Lívia Santos"
          },
          "document_number": "802.834.257-41",
          "representative_type": "attorney"
        }
      },
      {
        "analysis_representative_key": "d4c75c93-4aa9-4567-89c4-b49334927721",
        "document_number": "883.512.866-80",
        "person_data": {
          "name": "Natália Nascimento",
          "email": "natália.nascimento@yopmail.com",
          "phone": {
            "number": "36360268",
            "area_code": "11"
          },
          "address": {
            "uf": "SP",
            "city": "São Paulo",
            "number": "215",
            "street": "Gilberto Sabino",
            "country": "BRA",
            "postal_code": "05425-020",
            "neighborhood": "Pinheiros"
          },
          "person_type": "natural_person",
          "natural_person": {
            "birthdate": "1978-04-11",
            "mother_name": "Lívia Santos"
          },
          "document_number": "883.512.866-80",
          "representative_type": "attorney"
        }
      }
    ],
    "documents": []
  }
}

info

É importante armazenar a analysis_key e as analysis_representative_key que serão utilizadas para envio de documentos do cedente e dos representantes.

Atualização de Cadastro de Cedente Pessoa Física

Request

ENDPOINT

/assignor_registry/assignor_registry/ASSIGNOR_REGISTRY_KEY

MÉTODO

PUT

Request Body
{
  "name": "Natália Nascimento",
  "document_number": "951.585.151-31",
  "person_type": "natural_person",
  "email": "natália.nascimento@yopmail.com",
  "maturity_level": "factoring",
  "address": {
    "street": "Gilberto Sabino",
    "number": "215",
	"complement": "Sample Apt1",
    "neighborhood": "Pinheiros",
    "city": "São Paulo",
    "postal_code": "05425-020",
    "uf": "SP",
    "country": "BRA"
  },
  "phone": {
    "area_code": "11",
    "number": "36360268"
  },
  "natural_person": {
    "mother_name": "Lívia Santos",
    "birthdate": "1978-04-11"
  }
}

Definição do Cedente

Campo	Tipo	Descrição	Caracteres
`name` *	string	Nome do cedente.	1 a 255
`maturity_level` *	string	Nível de maturidade (risco) do cedente. Ver Níveis de Maturidade	1 a 255
`document_number` *	string	Número de documento do cedente (CPF).	14 a 18
`person_type` *	string	Tipo de pessoa (física ou jurídica) do cedente.	1 a 255
`email` *	string	Endereço de e-mail do cedente.	1 a 255
`phone`	object	Objeto referenciando as informações do telefone do cedente. Ver Definição de Telefone.	-
`address` *	object	Objeto referenciando as informações do endereço do cedente. Ver Definição de Endereço.	-
`natural_person` *	object	Objeto referenciando as informações da pessoa física do cedente. Ver Definição de Pessoa Física.	-

*Campos obrigatórios.

Response

STATUS

202

Response Body
{
  "assignor_registry_key": "2c242f4b-ae30-4207-9c83-07194f66b95c",
  "status": "pending_registry",
  "name": "Natália Nascimento",
  "document_number": "951.585.151-31",
  "person_type": "natural_person",
  "maturity_level": "factoring",
  "email": "natália.nascimento@yopmail.com",
  "phone": {
    "number": "36360268",
    "area_code": "11"
  },
  "address": {
    "uf": "SP",
    "city": "São Paulo",
    "number": "215",
    "street": "Gilberto Sabino",
    "country": "BRA",
    "postal_code": "05425-020",
    "neighborhood": "Pinheiros"
  },
  "natural_person": {
    "birthdate": "1978-04-11",
    "mother_name": "Lívia Santos"
  },
  "last_analysis": {
    "analysis_key": "303ee51e-813d-45e2-b427-07a0e4b64836",
    "analysis_number": 1,
    "assignor_registry_key": "2c242f4b-ae30-4207-9c83-07194f66b95c",
    "status": "pending_documents",
    "analysis_data": {
      "name": "Natália Nascimento",
      "email": "natália.nascimento@yopmail.com",
      "phone": {
        "number": "36360268",
        "area_code": "11"
      },
      "address": {
        "uf": "SP",
        "city": "São Paulo",
        "number": "215",
        "street": "Gilberto Sabino",
        "country": "BRA",
        "postal_code": "05425-020",
        "neighborhood": "Pinheiros"
      },
      "person_type": "natural_person",
      "maturity_level": "factoring",
      "natural_person": {
        "birthdate": "1978-04-11",
        "mother_name": "Lívia Santos"
      },
      "document_number": "951.585.151-31"
    },
    "analysis_representatives": [],
    "documents": []
  }
}

info

É importante armazenar a analysis_key e as analysis_representative_key que serão utilizadas para envio de documentos do cedente e dos representantes.

Atenção!

Ao atualizar o cadastro de um cedente, uma nova análise cadastral é gerada, resultando em uma nova analysis_key e novas analysis_representative_key. O cadastro só será efetivamente atualizado após a aprovação desta nova análise.

Importante!

Não é possível atualizar dados essenciais do cedente como Nome, Número do Documento, Tipo de Pessoa. Os dados cadastrais passíveis de alteração incluem:

Email;
Endereço;
Telefone;
Representantes (inclusão e alteração de vigentes);
Nível do Cedente (em caso de evolução)

Definições

Definição de Endereço

Campo	Tipo	Descrição	Caracteres
`street` *	string	Nome da rua.	1 a 255
`number` *	string	Número do endereço.	1 a 4
`neighborhood` *	string	Bairro.	1 a 255
`city` *	string	Cidade.	1 a 255
`uf` *	string	Sigla do estado.	2
`complement`	string	Complemento do endereço.	1 a 255
`postal_code` *	string	Código postal.	9 (formato: XXXXX-XXX)
`country` *	string	País (sigla).	3

*Campos obrigatórios.

Definição de Telefone

Campo	Tipo	Descrição	Caracteres
`international_dial_code`	string	Código internacional de discagem.	1 a 3
`area_code` *	string	Código de área.	2
`number` *	string	Número de telefone.	8 a 9

*Campos obrigatórios.

Definição de Pessoa Jurídica

Campo	Tipo	Descrição	Caracteres
`foundation_date`	string	Data de fundação da empresa.	10 (formato: YYYY-MM-DD)
`activity_code`	string	Código de atividade da empresa.	10 (formato: XX.XX-X-XX)
`annual_revenues`	integer	Receita anual da empresa.	-
`representatives` *	array	Lista de representantes da empresa . Ver Definição de Representante**.	-

*Campos obrigatórios.

**Atualmente são aceitos apenas representantes Pessoa Física.

Definição de Representante

Campo	Tipo	Descrição	Caracteres
`name` *	string	Nome do representante.	1 a 255
`document_number`*	string	Número de documento do representante (CPF).	14 a 18
`person_type` *	string	Tipo de pessoa do representante (deve ser pessoa física).	1 a 255
`email` *	string	Endereço de e-mail do representante.	1 a 255
`phone`	object	Objeto referenciando as informações do telefone do representante. Ver Definição de Telefone.	-
`address`	object	Objeto referenciando as informações do endereço do representante. Ver Definição de Endereço.	-
`natural_person` *	object	Objeto referenciando as informações da pessoa física do representante. Ver Definição de Pessoa Física.	-

*Campos obrigatórios.

Definição de Pessoa Física

Campo	Tipo	Descrição	Caracteres
`birthdate` *	string	Data de nascimento da pessoa.	10 (formato: YYYY-MM-DD)
`gender`	string	Gênero da pessoa. Ver Enumerador de Gênero.	1 a 6 (valores: "male" ou "female")
`mother_name`	string	Nome da mãe da pessoa.	1 a 255

*Campos obrigatórios.

Enumerador de Gênero

Enumerador	Descrição
male	Masculino.
female	Feminino.

Enumeradores

Assignor Registry Status

Enumerador	Descrição
pending_registry	Pendente Registro
registered	Registrado

Analysis Status

Enumerador	Descrição
pending_documents	Pendente Documentos
sent_to_analysis	Enviado para Análise
in_manual_analysis	Em Análise Manual
approved	Aprovado
reproved	Reprovado

Representative Type

Enumerador	Descrição
president	Presidente
partner	Sócio
administrator	Administrador
director	Diretor
manager	Gestor
attorney	Procurador

Níveis de Maturidade

Enumerador: maturity_level

Enumerador	Descrição
factoring	Fomento Mercantil
assignor_risk	Risco Cedente
debtor_risk	Risco Sacado
limited_issuer_risk	Risco Sacado Limitado

Hierarquia de Níveis de Maturidade

Nível de Maturidade	Níveis Subsequentes
Fomento Mercantil	Risco do Cedente, Risco do Devedor, Risco do Emissor Limitado
Risco do Cedente	Risco do Devedor, Risco do Emissor Limitado
Risco do Devedor	Risco do Emissor Limitado
Risco do Emissor Limitado	-

Atualização de Cadastro

Atualização de Cadastro de Cedente Pessoa Jurídica​

Request​

Definição do Cedente​

Response​

Atualização de Cadastro de Cedente Pessoa Física​

Request​

Definição do Cedente​

Response​

Definições​

Definição de Endereço​

Definição de Telefone​

Definição de Pessoa Jurídica​

Definição de Representante​

Definição de Pessoa Física​

Enumerador de Gênero​

Enumeradores

Assignor Registry Status​

Analysis Status​

Representative Type​

Níveis de Maturidade​

Enumerador: maturity_level​

Hierarquia de Níveis de Maturidade​

Atualização de Cadastro de Cedente Pessoa Jurídica

Request

Definição do Cedente

Response

Atualização de Cadastro de Cedente Pessoa Física

Request

Definição do Cedente

Response

Definições

Definição de Endereço

Definição de Telefone

Definição de Pessoa Jurídica

Definição de Representante

Definição de Pessoa Física

Enumerador de Gênero

Assignor Registry Status

Analysis Status

Representative Type

Níveis de Maturidade

Enumerador: maturity_level

Hierarquia de Níveis de Maturidade