Definição de assinantes
Após o envio do cadastro do cedente, é possível, opcionalmente, definir conjuntos customizados de assinantes para a operação. Esses conjuntos determinam quais partes relacionadas (do cedente ou de avalistas) devem assinar cada tipo de documento, com possibilidade de regras por tipo de produto.
Caso nenhum conjunto customizado seja enviado, o sistema utiliza os conjuntos padrão definidos pela administradora.
Os conjuntos de assinantes (signer_group_sets) representam grupos de assinantes vinculados a um proprietário (owner), que pode ser o cedente (assignor_registry), um avalista (guarantor) ou o cônjuge de um avalista pessoa física (spouse).
A definição customizada permite, por exemplo, exigir múltiplos assinantes, ou restringir quem pode assinar determinado produto.
A definição de conjuntos customizados deve ocorrer antes da etapa de Envio para Análise. Após o envio para análise, os conjuntos vigentes serão utilizados nas assinaturas dos contratos de cessão.
Definição de Conjunto Customizado para o Cedente
Permite ao cliente substituir o conjunto padrão de assinantes do cedente por um ou mais conjuntos customizados, organizados por produto. Os assinantes informados devem corresponder a partes relacionadas previamente cadastradas como representantes do cedente.
| Perfil | Host | Permissão exigida |
|---|---|---|
| Gestora | manager-api | Escrita |
| Consultoria | consultant-api | Cadastrar Cedente |
URL base de cada host: Ambientes (Hosts).
Request
{
"signer_group_sets": [
{
"product": "assignment_contract",
"signer_groups": [
{
"minimum_required_signers": 2,
"signers": [
{
"document_number": "123.456.789-09",
"is_required_signer": true
},
{
"document_number": "969.698.790-03",
"is_required_signer": false
}
],
"expiration": "2026-12-31"
}
]
},
{
"product": "commercial_paper",
"signer_groups": [
{
"minimum_required_signers": 1,
"signers": [
{
"document_number": "123.456.789-09",
"is_required_signer": true
}
],
"expiration": "2026-12-31"
}
]
}
]
}
Response
Sem conteúdo no corpo de resposta.
A criação de um conjunto customizado para o cedente substitui o conjunto main (padrão) vigente para o produto informado. Apenas os conjuntos com status igual a valid são utilizados nas assinaturas.
Ao enviar, o grupo de assinantes nasce no status in_analysis. Signer groups sets neste status não são enviados para assinatura. Com a aprovação do cadastro, o grupo passa para o status valid, e só então, será utilizado para assinaturas acima do main signer group.
Caso o custom signer group enviado seja menos restritivo que o validado pela Administradora, a análise será negada.
Erros
| Status | Código | Quando acontece |
|---|---|---|
| 404 | ASR000004 | Cedente não encontrado para o assignor_registry_key informado. Verificar se o assignor_registry_key está correto. |
| 404 | ASR000033 | Análise não encontrada para o analysis_key informado. Verificar se o analysis_key está correto. |
| 400 | ASR000066 | Status da análise não permite definição de grupos customizados. A análise deve estar em pending_documents para receber grupos customizados. |
| 404 | ASR000109 | Tipo de produto inválido. Usar um valor válido para product (ver enum Product Type). |
| 400 | ASR000118 | Signatário inválido. O document_number enviado em signers deve corresponder a um representante já cadastrado para o cedente, com is_representative=true. |
Erros de autenticação, permissão e host: veja Erros da API.
Definição de Conjunto Customizado para Parte Relacionada
Permite definir conjuntos customizados para um avalista ou para o cônjuge de um avalista pessoa física, utilizando a analysis_related_party_key retornada na criação da análise.
Este endpoint customiza os assinantes de um avalista ou do cônjuge de um avalista pessoa física, identificado pela analysis_related_party_key. Para os representantes do próprio cedente, use o endpoint de conjunto customizado do cedente acima. Para outras partes relacionadas, a chamada não cria conjunto.
| Perfil | Host | Permissão exigida |
|---|---|---|
| Gestora | manager-api | Escrita |
| Consultoria | consultant-api | Cadastrar Cedente |
URL base de cada host: Ambientes (Hosts).
Request
{
"signer_group_sets": [
{
"product": "assignment_contract",
"signer_groups": [
{
"minimum_required_signers": 1,
"signers": [
{
"document_number": "111.444.777-35",
"is_required_signer": true
}
],
"expiration": "2026-12-31"
}
]
}
]
}
Response
Sem conteúdo no corpo de resposta.
Ao enviar, o grupo de assinantes nasce no status in_analysis. Signer groups sets neste status não são enviados para assinatura. Com a aprovação do cadastro, o grupo passa para o status valid, e só então, será utilizado para assinaturas acima do main signer group.
Caso o custom signer group enviado seja menos restritivo que o validado pela Administradora, a análise será negada.
Erros
| Status | Código | Quando acontece |
|---|---|---|
| 404 | ASR000004 | Cedente não encontrado para o assignor_registry_key informado. Verificar se o assignor_registry_key está correto. |
| 404 | ASR000033 | Análise não encontrada para o analysis_key informado. Verificar se o analysis_key está correto. |
| 404 | ASR000035 | Parte relacionada da análise não encontrada para o analysis_related_party_key informado. Verificar se o analysis_related_party_key corresponde a um avalista ou cônjuge de avalista da análise. |
| 400 | ASR000066 | Status da análise não permite definição de grupos customizados. A análise deve estar em pending_documents para receber grupos customizados. |
| 404 | ASR000109 | Tipo de produto inválido. Usar um valor válido para product (ver enum Product Type). |
| 400 | ASR000118 | Signatário inválido. O document_number enviado em signers deve corresponder a um representante já cadastrado para a parte relacionada (avalista ou representante de avalista). |
Erros de autenticação, permissão e host: veja Erros da API.
Consulta de Conjuntos de Assinantes
Para consultar os conjuntos vigentes (padrão e customizados) e obter a signer_group_set_key, use a Consulta de Assinantes. Os enumeradores de owner_type, product_type, signer_group_set_type e status estão documentados nessa página.
Definições
Definição de Item de Envio (Signer Group Set Item)
Estrutura utilizada no corpo das requisições de criação de conjuntos customizados.
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
product * | string | Tipo de produto ao qual o conjunto será associado. | Ver Product Type. |
signer_groups * | array | Lista de grupos de assinantes (mínimo 1). | Ver Definição de Grupo de Assinantes. |
*Campos obrigatórios.
Definição de Grupo de Assinantes (Signer Group)
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
minimum_required_signers * | number | Quantidade mínima de assinantes do grupo necessários para validar a assinatura. | Mínimo 1 |
signers * | array | Lista de assinantes do grupo (mínimo 1). | Ver Definição de Assinante. |
expiration | string | Data de expiração do grupo no formato YYYY-MM-DD. Aceito no envio; na consulta, grupos expirados não aparecem. | 10 |
*Campos obrigatórios.
Definição de Assinante (Signer)
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
document_number * | string | CPF do assinante no formato XXX.XXX.XXX-XX. | 14 |
is_required_signer * | boolean | Indica se o assinante é obrigatório no grupo. | - |
*Campos obrigatórios.
Os document_number enviados devem corresponder a partes relacionadas (representantes do cedente, ou representantes do avalista em questão) presentes no cadastro do cedente. Documentos que não estiverem associados ao cedente serão rejeitados.