Este objeto representa uma etapa da esteira.

id
string

Identificador exclusivo para o objeto.

Example:

"step_5f92f01728e009f403d8502e"

loan
string

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

Example:

"loan_5f92f01728e009f403d8502e"

slug
string

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

Example:

"analiseCredito"

status
enum<string>
default:pending

Status atual da etapa.

Available options:
pending,
in_progress,
done,
failed
Example:

"pending"

title
string

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

Example:

"Verificação de Crédito"

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"

needs
string[]

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

Example:
["etapaAnterior", "outraEtapaAnterior"]
result
object

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

Example:
{ "approved": true }
description
string

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

Example:

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

tags
string

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.

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.

createdAt
string

Data de criação do objeto

Example:

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

updatedAt
string

Data de alteração do objeto

Example:

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

deleted
boolean
default:false

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

Example:

false

createdBy
object
updatedBy
object