Steps

Uma lista de etapas.

hasMore

boolean

Informa se existem mais itens. Os próximos itens podem ser obtidos informando o ID do último item no startingAfter.

Example:

true

data

object[]

Uma lista de etapas

Este objeto representa uma etapa da esteira.

data.id

string

Identificador exclusivo para o objeto.

Example:

"step_5f92f01728e009f403d8502e"

data.loan

string

ID do empréstimo ao qual esta etapa está vinculada.

Example:

"loan_5f92f01728e009f403d8502e"

data.slug

string

Identificador amigável e legível que descreve o propósito da etapa.

Example:

"analiseCredito"

data.status

enum<string>

default:pending

Status atual da etapa.

Available options:

pending,

in_progress,

done,

failed

Example:

"pending"

data.title

string

Título da etapa para exibição em interfaces de usuário.

Example:

"Verificação de Crédito"

data.type

enum<string>

Tipo identificador que categoriza a natureza desta etapa.

Available options:

signature,

disburse,

document_verification,

pass,

valid_employment,

custom_request,

unico,

attachments_to_request

Example:

"document_verification"

data.needs

string[]

Lista de dependências necessários para iniciar esta etapa.

Example:

["etapaAnterior", "outraEtapaAnterior"]

data.result

object

Objeto que contém o resultado desta etapa, se aplicável.

Example:

{ "approved": true }

data.description

string

Descrição detalhada ou motivo, geralmente usado quando a etapa falha.

Example:

"Motivo pelo qual documento do cliente foi considerado inválido."

data.tags

string

Tags ou etiquetas para categorização ou filtragem adicional.

Example:

"document_invalid"

data.methodData

object

Objeto que contém dados específicos para o tipo de etapa. Por exemplo, se a etapa for do tipo signature, este objeto conterá os dados necessários para a assinatura do documento.

data.metadata

object

Conjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.

data.createdAt

string

Data de criação do objeto

Example:

"2023-08-25T22:38:41.134Z"

data.updatedAt

string

Data de alteração do objeto

Example:

"2023-08-25T22:38:41.134Z"

data.deleted

boolean

default:false

Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.

Example:

false

data.createdBy

object

data.updatedBy

object

Step Loan

{
  "hasMore": true,
  "data": [
    {
      "id": "step_5f92f01728e009f403d8502e",
      "loan": "loan_5f92f01728e009f403d8502e",
      "slug": "analiseCredito",
      "status": "pending",
      "title": "Verificação de Crédito",
      "type": "document_verification",
      "needs": [
        "etapaAnterior",
        "outraEtapaAnterior"
      ],
      "result": {
        "approved": true
      },
      "description": "Motivo pelo qual documento do cliente foi considerado inválido.",
      "tags": "document_invalid",
      "methodData": {
        "type": "operator",
        "role": "approver"
      },
      "metadata": {},
      "createdAt": "2023-08-25T22:38:41.134Z",
      "updatedAt": "2023-08-25T22:38:41.134Z",
      "deleted": false,
      "createdBy": {
        "clientId": "client_identifier",
        "externalClientId": "<string>",
        "app": "backoffice"
      },
      "updatedBy": {
        "clientId": "client_identifier",
        "externalClientId": "<string>",
        "app": "backoffice"
      }
    }
  ]
}

Empréstimos

Empresas

Clientes

Fundos

Eventos

Cobrança

Arquivos

Configurações

Entidades

Automações

Modelos