POST
/
v1
/
steps
/
{id}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

Chave única de idempotência para evitar duplicação de requisições.

Path Parameters

id
string
required
  • O ID do object

Query Parameters

expand
string

Expande as referências.

Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.

Body

application/json

Este objeto representa uma etapa da esteira.

status
enum<string>
default: pending

Status atual da etapa.

Available options:
pending,
in_progress,
done,
failed
description
string

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

tags
string

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

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.

Response

200 - application/json

Este objeto representa uma etapa da esteira.

id
string

Identificador exclusivo para o objeto.

loan
string

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

slug
string

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

status
enum<string>
default: pending

Status atual da etapa.

Available options:
pending,
in_progress,
done,
failed
title
string

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

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,
unico_check
needs
string[]

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

result
object

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

description
string

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

tags
string

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

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

updatedAt
string

Data de alteração do objeto

deleted
boolean
default: false

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