Skip to main content
GET
/
v1
/
steps
Listar etapas
curl --request GET \
  --url https://api.base39.io/v1/steps \
  --header 'Authorization: Bearer <token>'
{
  "hasMore": true,
  "data": [
    {
      "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": {
        "schema": {
          "type": "operator",
          "role": "approver"
        }
      },
      "metadata": {},
      "createdAt": "2023-08-25T22:38:41.134Z",
      "updatedAt": "2023-08-25T22:38:41.134Z",
      "deleted": false
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
loan
string

ID do empréstimo

​
status
enum<string>

O status do passo da esteira, como done, in_progress ou failed. O valor deve ser uma string ou uma lista separada por vírgula.

Available options:
pending,
in_progress,
done,
failed
​
type
enum<string>

O tipo da etapa, como signature ou document_verification. O valor deve ser uma string ou uma lista separada por vírgula.

Available options:
signature,
disburse,
document_verification,
pass,
valid_employment,
custom_request,
create_documents,
attachments_to_request,
unico
​
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.

​
starting_after
string

Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.

​
ending_before
string

Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.

​
limit
integer
default:10

Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100, e o padrão é 10.

Response

200 - application/json

Um objeto com uma propriedade data que contém um array de itens começando após o item starting_after. Cada entrada no array é um objeto Step separado. Se não houver mais itens, o array estará vazio. Essa solicitação nunca deve retornar um erro.

Uma lista de etapas. A parte de uma resposta da API que descreve a paginação

​
hasMore
boolean

Informa se existem mais itens. Os próximos itens podem ser obtidos informando o ID do último item no startingAfter.

Example:

true

​
data
Step · object[]

Uma lista de etapas

⌘I