Listar passos da esteira de empréstimos

GET 
/v1/loans/:loan/steps

Retorna todas as etapas da esteira do empréstimo, ordenadas por data de criação, com as mais recentes primeiro.

Request

Path Parameters

loan stringrequired
ID do empréstimo
Example: loan_5f92f01728e009f403d8502e

Query Parameters

fields string

Permite especificar quais campos devem ser incluídos ou excluídos na resposta. Utilize o nome do campo para incluí-lo, ou prefixe o nome com um sinal de menos (-) para excluí-lo. Pode ser um valor único ou uma lista separada por vírgula(csv). Funciona para campos expandidos.

Esteja ciente de que especificar um campo para inclusão, terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Importante: Não é permitido combinar inclusões e exclusões na mesma requisição. Uma tentativa de fazê-lo resultará em um erro.

Examples:

inclusao

Retorna apenas os campos `id` e `createdAt`.

Example: id,createdAt

exclusao

Retorna todos os campos, exceto `id`.

Example: -id

status string
Possible values: [pending, in_progress, done, failed]
O status pode ser done, in_progress, ou failed, como uma string ou lista de strings.
Example: done
type string
Possible values: [signature, disburse, document_verification, pass, valid_employment, custom_request, create_documents, attachments_to_request, unico]
O tipo da etapa pode ser signature, document_verification, ou uma lista desses valores.
Example: signature
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.
Example: data.loan
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.
Example: obj_5f92f01728e009f403d8502e
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.
Example: obj_5f92f01728e009f403d8502e
limit integer
Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100, e o padrão é 10.
Default value: 10
Example: 10

Responses

200

Um objeto com data contendo um array de itens Step após starting_after. Se não houver mais itens, o array será vazio. A solicitação nunca falha.

application/json

Schema

Schema

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

object[]

Uma lista de etapas

Array [

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 string

Status atual da etapa.

Possible values: [pending, in_progress, done, failed]

Default value: pending

Example: pending

title string

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

Example: Verificação de Crédito

type string

Tipo identificador que categoriza a natureza desta etapa.

Possible values: [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.

anyOf

signature

Configuração do responsável pela assinatura.

type string

Tipo responsável pela assinatura.

Possible values: [operator, customer]

role string

Papel assumido.

Possible values: [approver, financial, administrator, backoffice]

Example: approver

document_verification

Tipo de documento para verificação.

purpose string

Propósito

Possible values: [account_requirement, org_icon, org_logo, identity_document, additional_verification, selfie, ccb, signature, ccb_signed, insurance, identity_document_front, identity_document_back, pay_stub, proof_of_address, insurance_signature, insurance_signed]

valid_employment

Configuração para validação de employment.

createdBy string

Definição de quem deveria ter criado o employment.

Possible values: [customer, operator]

custom_request

Configuração para realizar a request customizável.

url stringrequired

Url a ser chamada.

Example: https://api.example.com

headers object

Valor do header Authorization

create_documents

Configuração para criar documentos.

documents

object[]

Documentos criados após a criação do empréstimo, exemplos: ccb, seguro, etc…

Array [

purpose string

Possible values: [ccb, signature, insurance]

engine

object

type string

Template engine usado para gerar documentos.

Possible values: [google]

options

object

template string

Template utilizado no engine para gerar o documento.

]

unico

Configuração de integração com a unico.io.

minScore number

Score mínimo aceito na validação de identidade. Esta propriedade somente será utilizada se o resultado da validação da biometria UNICO não for conclusiva. Para maiores informações, consulte o funcionamento do score.

Possible values: >= -100 and <= 100

Example: 70

attachments_to_request

Tipo de anexos para verificação.

purpose string[]

Possible values: [account_requirement, identity_document, additional_verification, selfie, identity_document_front, identity_document_back, pay_stub, proof_of_address]

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 date-time

Data de criação do objeto

Example: 2023-08-25T22:38:41.134Z

updatedAt date-time

Data de alteração do objeto

Example: 2023-08-25T22:38:41.134Z

deleted boolean

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

Default value: false

Example: false

createdBy

object

clientId string

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientId string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

app string

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy

object

clientId string

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientId string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

app string

Nome da aplicação que criou a assinatura.

Example: backoffice

]

Example (from schema)

{
  "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": {
        "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"
      }
    }
  ]
}

Loading...