Atualizar etapa
Atualiza uma etapa da esteira
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
Chave única de idempotência para evitar duplicação de requisições.
Path Parameters
- O ID do object
Query Parameters
Expande as referências.
Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.
Body
Este objeto representa uma etapa da esteira.
Status atual da etapa.
pending
, in_progress
, done
, failed
Descrição detalhada ou motivo, geralmente usado quando a etapa falha.
Tags ou etiquetas para categorização ou filtragem adicional.
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.
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
Este objeto representa uma etapa da esteira.
Identificador exclusivo para o objeto.
ID do empréstimo ao qual esta etapa está vinculada.
Identificador amigável e legível que descreve o propósito da etapa.
Status atual da etapa.
pending
, in_progress
, done
, failed
Título da etapa para exibição em interfaces de usuário.
Tipo identificador que categoriza a natureza desta etapa.
signature
, disburse
, document_verification
, pass
, valid_employment
, custom_request
, unico
, attachments_to_request
, unico_check
Lista de dependências necessários para iniciar esta etapa.
Objeto que contém o resultado desta etapa, se aplicável.
Descrição detalhada ou motivo, geralmente usado quando a etapa falha.
Tags ou etiquetas para categorização ou filtragem adicional.
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.
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 de criação do objeto
Data de alteração do objeto
Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.