📂 Documentos

Dentro da estrutura do Titan CaaS, a inclusão de documentos em uma operação desempenha um papel fundamental na robustez e transparência do processo de originação de solicitações de crédito, empréstimos e transações financeiras correlatas. Essa funcionalidade permite que as instituições financeiras enriqueçam e detalhem cada operação ao incorporar documentos informativos relevantes.

Ao fazer isso, a plataforma facilita uma compreensão abrangente das circunstâncias e necessidades associadas a cada operação. Ao oferecer essa capacidade de inclusão de documentos, o Titan CaaS capacita as instituições a aprimorar a análise de crédito, ao mesmo tempo em que promove a eficiência operacional e a clareza no processo de tomada de decisão.

Essa abordagem contribui para a criação de uma base sólida e confiável para a condução de operações financeiras, garantindo a documentação adequada e promovendo a confiança tanto para as instituições quanto para os clientes envolvidos.

Passo 1: Envio e vinculo do arquivo a um cliente, avalista ou garantia

Antes de vincular a documentação em uma operação, é necessário carregar o arquivo a um cliente, avalista (seja pessoa física ou jurídica) ou garantia. Após concluído conforme as instruções abaixo, os demais vínculos são estabelecidos.

Pessoa física

Parâmetros de envio

Atributo	Correspondência	Obrigatoriedade	Tipo de dado	Valor padrão
Arquivo	`file`	Sim	Binary	-
Identificador da categoria do arquivo	`attachmentTypeID`	Sim	Number	-
Data de vencimento	`dueDate`	Não	Date	-
Visibilidade na esteira de crédito	`visible`	Sim	Boolean	-
Identificador da pessoa	`personID`	Sim	Number	-

Padrão de API:

POST {{ _.base_url }}/api/person-attachments/{personID}/upload

Exemplo de rota:

POST https://{empresa}.titan.ceoslab.app/api/person-attachments/2760/upload

`Header`:

{
    "Content-Type": "multipart/form-data;",
    "Titan-Api-Key": "{Sua chave API}"
}

`Body`:

{
    "file": "FILE(form-data)",
    "attachmentTypeID": 18,
    "dueDate": "2025-01-01",
    "visible": true
}

Exemplo de resposta

{
    "id": 7558,
    "createdAt": "2024-02-21T16:35:15.636778Z",
    "updatedAt": "2024-02-21T16:35:15.636781Z",
    "createdByID": 2760,
    "updatedByID": 2760,
    "enabled": true,
    "dueDate": "2025-01-01",
    "uid": "1708533315-8fb31656-7b91-42b8-93b4-48e869251f83",
    "filename": "imagem-pessoa-teste.jpeg",
    "size": 262009,
    "mimeType": "image/jpeg",
    "attachmentTypeID": 18,
    "attachmentType": null,
    "visible": true,
    "sha256sum": "ee8d0b3fe537830ae4665824fb35d11944d7a937ecc0d5b16a3d2d4b8c0765f8"
}

Pessoa jurídica

Parâmetros de envio

Atributo	Correspondência	Obrigatoriedade	Tipo de dado	Valor padrão
Arquivo	`file`	Sim	Binary	-
Identificador da categoria do arquivo	`attachmentTypeID`	Sim	Number	-
Data de vencimento	`dueDate`	Não	Date	-
Visibilidade na esteira de crédito	`visible`	Sim	Boolean	-
Identificador da empresa	`companyID`	Sim	Number	-

Padrão de API:

POST {{ _.base_url }}/api/company-attachments/{companyID}/upload

Exemplo de rota:

POST https://{empresa}.titan.ceoslab.app/api/company-attachments/1551/upload

`Header`:

{
    "Content-Type": "multipart/form-data;",
    "Titan-Api-Key": "{Sua chave API}"
}

`Body`:

{
    "file": "FILE(form-data)",
    "attachmentTypeID": 18,
    "dueDate": "2025-01-01",
    "visible": true
}

Exemplo de resposta

{
    "id": 7562,
    "createdAt": "2024-02-22T16:35:15.636778Z",
    "updatedAt": "2024-02-22T16:35:15.636781Z",
    "createdByID": 2760,
    "updatedByID": 2760,
    "enabled": true,
    "dueDate": "2025-01-01",
    "uid": "5608533315-8fb31656-7b91-42b8-93b4-48e869251f83",
    "filename": "imagem-empresa-teste.jpeg",
    "size": 647284,
    "mimeType": "image/jpeg",
    "attachmentTypeID": 18,
    "attachmentType": null,
    "visible": true,
    "sha256sum": "io8d0b3fe537830ae4665824fb35d11944d7a937ecc0d5b16a3d2d4b8c0765f8"
}

Garantia

Parâmetros de envio

Atributo	Correspondência	Obrigatoriedade	Tipo de dado	Valor padrão
Arquivo	`file`	Sim	Binary	-
Identificador da categoria do arquivo	`attachmentTypeID`	Sim	Number	-
Data de vencimento	`dueDate`	Não	Date	-
Visibilidade na esteira de crédito	`visible`	Sim	Boolean	-
Identificador da garantia	`collateralID`	Sim	Number	-

Padrão de API:

POST {{ _.base_url }}/api/collateral-attachments/{collateralID}/upload

Exemplo de rota:

POST https://{empresa}.titan.ceoslab.app/api/collateral-attachments/1298/upload

`Header`:

{
    "Content-Type": "multipart/form-data;",
    "Titan-Api-Key": "{Sua chave API}"
}

`Body`:

{
    "file": "FILE(form-data)",
    "attachmentTypeID": 18,
    "dueDate": "2025-01-01",
    "visible": true
}

Exemplo de resposta

{
    "id": 7674,
    "createdAt": "2024-02-23T16:35:15.636778Z",
    "updatedAt": "2024-02-23T16:35:15.636781Z",
    "createdByID": 2760,
    "updatedByID": 2760,
    "enabled": true,
    "dueDate": "2025-01-01",
    "uid": "7108533315-8fb31656-7b91-42b8-93b4-48e869251f83",
    "filename": "imagem-garantia-teste.jpeg",
    "size": 206017,
    "mimeType": "image/jpeg",
    "attachmentTypeID": 18,
    "attachmentType": null,
    "visible": true,
    "sha256sum": "fg8d0b3fe537830ae4665824fb35d11944d7a937ecc0d5b16a3d2d4b8c0765f8"
}

Passo 2: Vinculo do documento com uma operação

Depois de enviar e vincular o documento às entidades mencionadas anteriormente, utilizando o id gerado na resposta da API, você será capaz de associar a documentação à sua operação.

Pessoa física

Parâmetros de envio

Atributo	Correspondência	Obrigatoriedade	Tipo de dado	Valor padrão
Identificador do documento	`attachmentID`	Sim	Number	-
Identificador da operação	`operationID`	Sim	Number	-
Identificador da pessoa	`personID`	Sim	Number	-

Padrão de API:

POST {{ _.base_url }}/api/operations-attachments

Exemplo de rota:

POST https://{empresa}.titan.ceoslab.app/api/operations-attachments

Exemplo de requisição:

{
    "attachmentID": 7558,
    "operationID": 5401,
    "personID": 2760
}

Exemplo de resposta:

{
    "id": 1604,
    "createdAt": null,
    "updatedAt": null,
    "createdByID": 2760,
    "updatedByID": 2760,
    "enabled": true,
    "attachmentID": 7558,
    "attachment": null,
    "visible": null,
    "operationID": 5401,
    "companyID": null,
    "company": null,
    "personID": 2760,
    "person": null,
    "collateralID": null,
    "collateral": null
}

Pessoa jurídica

Parâmetros de envio

Atributo	Correspondência	Obrigatoriedade	Tipo de dado	Valor padrão
Identificador do documento	`attachmentID`	Sim	Number	-
Identificador da operação	`operationID`	Sim	Number	-
Identificador da empresa	`companyID`	Sim	Number	-

Padrão de API:

POST {{ _.base_url }}/api/operations-attachments

Exemplo de rota:

POST https://{empresa}.titan.ceoslab.app/api/operations-attachments

Exemplo de requisição:

{
    "attachmentID": 7562,
    "operationID": 5401,
    "companyID": 1551
}

Exemplo de resposta:

{
    "id": 1610,
    "createdAt": null,
    "updatedAt": null,
    "createdByID": 2760,
    "updatedByID": 2760,
    "enabled": true,
    "attachmentID": 7562,
    "attachment": null,
    "visible": null,
    "operationID": 5401,
    "companyID": 1551,
    "company": null,
    "personID": null,
    "person": null,
    "collateralID": null,
    "collateral": null
}

Documentos assinados

Este procedimento refere-se ao momento em que a fase de assinatura do contrato da operação deve ser autorizada para envio externo ao Titan (veja como definir o processo de assinatura externo ao Titan aqui). Portanto, é imprescindível que o contrato assinado referente à operação seja devolvido, seguindo os passos abaixo:

Parâmetros de envio

Atributo	Correspondência	Obrigatoriedade	Tipo de dado	Valor padrão
Arquivo	`file`	Sim	Binary	-
Identificador da categoria do arquivo	`attachmentTypeID`	Sim	Number	-
Data de vencimento	`dueDate`	Não	Date	-
Identificador do assinante	`subscriberID`	Não	Number	-

subscriberID é opcional, entenda:

Se o subscriberID não for fornecido na requisição, o documento contratual assinado fica vinculado à operação em si, sem uma ligação direta a um assinante.

Padrão de API:

POST {{ _.base_url }}/api/operations-signatures-attachments/upload

Exemplo de rota:

POST https://{empresa}.titan.ceoslab.app/api/operations-signatures-attachments/upload

Exemplo de requisição:

`Header`:

{
    "Content-Type": "multipart/form-data;",
    "Titan-Api-Key": "{Sua chave API}"
}

`Body`:

{
    "file": "FILE(form-data)",
    "attachmentTypeID": 18,
    "dueDate": "2025-01-01",
    "subscriberID": 2052
}

Exemplo de resposta

{
    "id": 2052,
    "createdAt": null,
    "updatedAt": null,
    "createdByID": 2760,
    "updatedByID": 2760,
    "enabled": true,
    "attachmentID": 7674,
    "attachment": null,
    "visible": null,
    "operationSignatureID": 2204,
    "unicoDocumentType": null,
    "personID": 2760,
    "person": null
}

Listagem dos documentos contratuais

Após o envio dos documentos contratuais, você pode listar os anexos referente aquela operação. Veja como utilizar a API de operations-signatures-attachments.

Padrão de API:

GET {{ _.base_url }}/api/operations-signatures-attachments?filters[operationSignatureID][$eq]={operationSignatureID}

Exemplo de rota:

GET https://{empresa}.titan.ceoslab.app/api/operations-signatures-attachments?filters[operationSignatureID][$eq]=2204

Exemplo de resposta

{
    "content": [
        {
            "id": 2052,
            "createdAt": "2024-02-21T19:54:44.398221Z",
            "updatedAt": "2024-02-21T19:54:44.398226Z",
            "createdByID": 2760,
            "updatedByID": 2760,
            "enabled": true,
            "attachmentID": 7674,
            "attachment": {
                "id": 7674,
                "createdAt": "2024-02-21T19:54:44.394935Z",
                "updatedAt": "2024-02-21T19:54:44.394939Z",
                "createdByID": 2760,
                "updatedByID": 2760,
                "enabled": true,
                "dueDate": "2025-01-01",
                "uid": "1708545284-5d50c78b-241b-40f0-b4bd-77b4ff9d555e",
                "filename": "Contrato-assinado.pdf",
                "size": 32440,
                "mimeType": "application/pdf",
                "attachmentTypeID": 18,
                "attachmentType": {
                    "id": 18,
                    "text": "OUTRO",
                    "enabled": true
                },
                "visible": false,
                "sha256sum": "206f0a8588f64bc7183794725fbcf5b5dd0ee2cd1c9e675c2c4b11e912ae1d2a"
            },
            "visible": null,
            "operationSignatureID": 2204,
            "unicoDocumentType": null,
            "personID": 2760,
            "person": {
                ...
            }
        },
        ...
    ],
    ...
}

Lastro

O lastro da operação corresponde a toda documentação das entidades envolvidas na operação. Entre os documentos que podem estar incluídos dentro do lastro, estão:

Documentação completa vinculada ao cliente;
Documentação completa vinculada ao(s) avalista(s);
Documentação completa vinculada a(s) garantia(s);
Documentação completa vinculada a operação;
Documentos de assinatura.

Parâmetros de envio

Atributo	Correspondência	Obrigatoriedade	Tipo de dado	Valor padrão
Identificador da operação	`operationID`	Sim	Number	-

Padrão de API:

GET {{ _.base_url }}/api/operations/{operationID}/ballast

Exemplo de requisição:

GET https://{empresa}.titan.ceoslab.app/api/operations/1002/ballast

Tipo de resposta:

📁 application/zip

Mapeamento de atributos

O processo de mapeamento de atributos é essencial para compreender a relação entre os identificadores (IDs) utilizados nesta API e os atributos específicos que cada ID representa. Nesta seção, apresentamos uma tabela abrangente que associa cada ID a uma descrição do respectivo atributo correspondente. Essa abordagem visa simplificar a compreensão, fornecendo informações claras e significativas sobre a função de cada identificador no contexto da inclusão de documentos em uma operação dentro do Titan.

Categoria do arquivo (`attachmentTypeID`):

Padrão de API:

GET {{ _.base_url }}/api/attachment-types/list

Exemplo de rota:

GET https://{empresa}.titan.ceoslab.app/api/attachment-types/list

Exemplo de resposta:

[
    {
        "id": 1,
        "text": "EXTRATO BANCÁRIO",
        "enabled": true
    },
    {
        "id": 2,
        "text": "SELFIE COM DOCUMENTO",
        "enabled": true
    },
    {
        "id": 18,
        "text": "OUTRO",
        "enabled": true
    },
    ...
]

Pessoa (`personID`):

No processo de criação de operação via API, na resposta da requisição você tem acesso ao personID.

Empresa (`companyID`):

No processo de criação de operação via API, na resposta da requisição você tem acesso ao companyID.

Operação (`operationID`):

No processo de criação de operação via API, na resposta da requisição você tem acesso ao operationID.

Garantia (`collateralID`):

Para obter o identificador da garantia, é necessário listar as garantias associadas à operação em questão. Para isso, inicialmente, é necessário ter o identificador da operação, citado no tópico anterior. Com o identificador da operação em que sua garantia desejada está associada, faça a seguinte requisição:

Padrão de API:

GET {{ _.base_url }}/api/collaterals?filters[operationID][$eq]={operationID}

Exemplo de rota:

GET https://{empresa}.titan.ceoslab.app/api/collaterals?filters[operationID][$eq]=5401

Exemplo de resposta:

{
    "content": [
        {
            "id": 1707,
            "createdAt": "2023-12-13T16:47:10.645767Z",
            "updatedAt": "2023-12-13T16:47:10.645771Z",
            "createdByID": 2760,
            "updatedByID": 2760,
            "enabled": true,
            "value": 10000.00,
            "description": "",
            "collateralTypeID": 1,
            "collateralType": {
                "id": 1,
                "text": "Alienação fiduciária",
                "enabled": true
            },
            "assetTypeID": 154,
            "assetType": {
                "id": 154,
                "text": "Equipamentos alimentícios",
                "enabled": true,
                "workflowNodeID": null
            },
            "vehicleID": null,
            "operationID": 5401,
            "agentID": null,
            "agent": null,
            "financed": false
        },
        ...
    ] 
}

Assinante (`subscriberID`):

Para obter o identificador do assinante, é necessário listar os assinantes associadas à operação em questão, definindo o processo de assinatura para envio externo ao Titan. Para isso, inicialmente, é necessário ter o identificador da operação, citado nos tópicos anteriores. Com o identificador da operação em que seu assinante desejado está associado, siga os passos a seguir:

Definir o envio de contrato externo ao Titan e obter o identificador da etapa de envio externo da operação.

Padrão de API:

POST {{ _.base_url }}/api/operation-signatures/{operationID}/send-contract-externally

Exemplo de rota:

POST https://{empresa}.titan.ceoslab.app/api/operation-signatures/5401/send-contract-externally

Exemplo de resposta:

{
    "id": 2204,
    "createdAt": null,
    "updatedAt": null,
    "createdByID": 2760,
    "updatedByID": 2760,
    "enabled": true,
    "operationID": 5401,
    "subscribers": null,
    "envelopeUUID": null,
    "sendMethod": "EXTERNAL"
}

Listar os assinantes da operação.

Padrão de API:

GET {{ _.base_url }}/api/operation-signature-subscribers?filters[operationID][$eq]={operationID}

Exemplo de rota:

GET https://{empresa}.titan.ceoslab.app/api/operation-signature-subscribers?filters[operationID][$eq]=5401

Exemplo de resposta:

{
    "content": [
        {
            "id": 2052,
            "createdAt": "2024-01-12T13:24:50.121637Z",
            "updatedAt": "2024-02-21T19:53:45.408554Z",
            "createdByID": 2760,
            "updatedByID": 2760,
            "enabled": true,
            "operationID": 5401,
            "processID": null,
            "operationSignatureID": 2204,
            "unicoCheckSignatureFinished": false,
            "personID": 2760,
            "person": {
                ...
            },
            "type": "BUSINESS_PARTNER",
            "action": null,
            "actionID": null
        },
        ...
    ]
}

📂 Documentos

Passo 1: Envio e vinculo do arquivo a um cliente, avalista ou garantia​

Pessoa física​

Parâmetros de envio​

Padrão de API:​

Exemplo de rota:​

Header:​

Body:​

Exemplo de resposta​

Pessoa jurídica​

Parâmetros de envio​

Padrão de API:​

Exemplo de rota:​

Header:​

Body:​

Exemplo de resposta​

Garantia​

Parâmetros de envio​

Padrão de API:​

Exemplo de rota:​

Header:​

Body:​

Exemplo de resposta​

Passo 2: Vinculo do documento com uma operação​

Pessoa física​

Parâmetros de envio​

Padrão de API:​

Exemplo de rota:​

Exemplo de requisição:​

Exemplo de resposta:​

Pessoa jurídica​

Parâmetros de envio​

Padrão de API:​

Exemplo de rota:​

Exemplo de requisição:​

Exemplo de resposta:​

Documentos assinados​

Parâmetros de envio​

Padrão de API:​

Exemplo de rota:​

Exemplo de requisição:​

Header:​

Body:​

Exemplo de resposta​

Padrão de API:​

Exemplo de rota:​

Exemplo de resposta​

Lastro​

Parâmetros de envio​

Padrão de API:​

Exemplo de requisição:​

Tipo de resposta:​

Mapeamento de atributos​

Categoria do arquivo (attachmentTypeID):​

Pessoa (personID):​

Empresa (companyID):​

Operação (operationID):​

Garantia (collateralID):​

Assinante (subscriberID):​

Passo 1: Envio e vinculo do arquivo a um cliente, avalista ou garantia

Pessoa física

Parâmetros de envio

Padrão de API:

Exemplo de rota:

`Header`:

`Body`:

Exemplo de resposta

Pessoa jurídica

Parâmetros de envio

Padrão de API:

Exemplo de rota:

`Header`:

`Body`:

Exemplo de resposta

Garantia

Parâmetros de envio

Padrão de API:

Exemplo de rota:

`Header`:

`Body`:

Exemplo de resposta

Passo 2: Vinculo do documento com uma operação

Pessoa física

Parâmetros de envio

Padrão de API:

Exemplo de rota:

Exemplo de requisição:

Exemplo de resposta:

Pessoa jurídica

Parâmetros de envio

Padrão de API:

Exemplo de rota:

Exemplo de requisição:

Exemplo de resposta:

Documentos assinados

Parâmetros de envio

Padrão de API:

Exemplo de rota:

Exemplo de requisição:

`Header`:

`Body`:

Exemplo de resposta

Padrão de API:

Exemplo de rota:

Exemplo de resposta

Lastro

Parâmetros de envio

Padrão de API:

Exemplo de requisição:

Tipo de resposta:

Mapeamento de atributos

Categoria do arquivo (`attachmentTypeID`):

Pessoa (`personID`):

Empresa (`companyID`):

Operação (`operationID`):

Garantia (`collateralID`):

Assinante (`subscriberID`):