Step

Este objeto representa uma etapa da esteira.

idstring

Identificador exclusivo para o objeto.

Example: step_5f92f01728e009f403d8502e

loanstring

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

Example: loan_5f92f01728e009f403d8502e

slugstring

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

Example: analiseCredito

statusstring

Status atual da etapa.

Possible values: [pending, in_progress, done, failed]

Default value: pending

Example: pending

titlestring

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

Example: Verificação de Crédito

typestring

Tipo identificador que categoriza a natureza desta etapa.

Possible values: [signature, disburse, document_verification, pass, valid_employment, custom_request, unico, attachments_to_request]

Example: document_verification

needsstring[]

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

Example: ["etapaAnterior","outraEtapaAnterior"]

resultobject

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

Example: {"approved":true}

descriptionstring

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

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

tagsstring

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

Example: document_invalid

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.

anyOf

signature

typestring

Tipo responsável pela assinatura.

Possible values: [operator, customer]

rolestring

Papel assumido.

Possible values: [approver, financial, administrator, backoffice]

Example: approver

document_verification

purposestring

Propósito

Possible values: [account_requirement, org_icon, org_logo, identity_document, additional_verification, selfie, ccb, signature, ccb_signed, insurance, identity_document_front, identity_document_back, pay_stub, proof_of_address, insurance_signature, insurance_signed]

valid_employment

createdBystring

Definição de quem deveria ter criado o employment.

Possible values: [customer, operator]

custom_request

urlstringrequired

Url a ser chamada.

Example: https://api.example.com

headersobject

Valor do header Authorization

create_documents

unico

minScorenumber

Score mínimo aceito na validação de identidade. Esta propriedade somente será utilizada se o resultado da validação da biometria UNICO não for conclusiva. Para maiores informações, consulte o funcionamento do score.

Possible values: >= -100 and <= 100

Example: 70

attachments_to_request

purposestring[]

Possible values: [account_requirement, identity_document, additional_verification, selfie, identity_document_front, identity_document_back, pay_stub, proof_of_address]

metadataobject

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.

createdAtdate-time

Data de criação do objeto

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

updatedAtdate-time

Data de alteração do objeto

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

deletedboolean

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

Default value: false

Example: false

createdBy object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

Step

{
  "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"
  }
}