Pular para o conteúdo principal

Listar etapas

GET 
/v1/steps

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

Request​

Query Parameters

    loan string

    ID do empréstimo

    Example: loan_5f92f01728e009f403d8502e
    status string

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

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

    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, como signature ou document_verification, pode ser uma string ou lista separada por vírgula.

    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​

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

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

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

  • ]

Loading...