Listar passos da esteira de empréstimos

GET

loans

{loan}

steps

curl --request GET \
  --url https://api.base39.io/v1/loans/{loan}/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.

Path Parameters

loan

string

required

ID do empréstimo

Query Parameters

fields

string[]

Uma lista separada por vírgulas de atributos a serem incluídos na resposta. Isso pode ser usado para solicitar campos que normalmente não são retornados em uma resposta padrão.

Esteja ciente de que especificar este parâmetro terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

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,

unico_check

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

limit

integer

default:

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`. Se não houver mais itens, o array estará vazio. Essa solicitação nunca deve retornar um erro.

Uma lista de etapas.

hasMore

boolean

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

data

object[]

Uma lista de etapas

data.id

string

Identificador exclusivo para o objeto.

data.loan

string

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

data.slug

string

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

data.status

enum<string>

default:

pending

Status atual da etapa.

Available options:

pending,

in_progress,

done,

failed

data.title

string

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

data.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

data.needs

string[]

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

data.result

object

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

data.description

string

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

data.tags

string

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

data.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.

data.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.

data.createdAt

string

Data de criação do objeto

data.updatedAt

string

Data de alteração do objeto

data.deleted

boolean

default:

false

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

Listar parcelas Atualizar empréstimo

curl --request GET \
  --url https://api.base39.io/v1/loans/{loan}/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
    }
  ]
}

Referências

Authorizations

Path Parameters

Query Parameters

Response