POST
/
v1
/
steps
/
{step}
curl --request POST \
  --url https://api.base39.io/v1/steps/{step} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "pending",
  "description": "Motivo pelo qual documento do cliente foi considerado inválido.",
  "tags": "document_invalid",
  "metadata": {}
}'
{
  "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"
  }
}

Authorizations

​
Authorization
string
header
required

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.

​
base39-external-client-id
string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição.

Path Parameters

​
step
string
required

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

Atualizar uma etapa

​
status
enum<string>
default:pending

Status atual da etapa.

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

"pending"

​
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"

​
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
Retorna o objeto `Step` atualizado.

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