SettingsSteps

Configurações do modo passo a passo

titlestring

Título identificador do passo.

typestring

Tipo identificador do passo.

Possible values: [signature, disburse, document_verification, pass, valid_employment, custom_request, create_documents, attachments_to_request, unico]

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

typestring

Tipo responsável pela assinatura.

Possible values: [operator, customer]

rolestring

Papel assumido.

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

Example: approver

document_verification

purposestring

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

createdBystring

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

Possible values: [customer, operator]

custom_request

urlstringrequired

Url a ser chamada.

Example: https://api.example.com

headersobject

Valor do header Authorization

create_documents

unico

minScorenumber

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

purposestring[]

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

needsstring[]

Array de dependência (slugs) entre os passos necessarios para que esse seja executado.

slugstring

Identificador único do passo.

hooks object

Definição de hooks da esteira.

onFailure object[]

Lista de ações que serão executadas se um passo da esteira falhar.

Array [

actionstring

Possible values: [void_loan, cancel_loan]

Example: ["void_loan"]

descriptionstring

Example: Ação de cancelamento de empréstimo.

]

onStart object[]

Lista de ações que serão executadas ao iniciar um passo da esteira.

Array [

actionstring

Possible values: [mark_loan_as_pending]

Example: ["mark_loan_as_pending"]

descriptionstring

Example: Marcar o empréstimo como pendente.

]

SettingsSteps

{
  "title": "string",
  "type": "signature",
  "methodData": {
    "type": "operator",
    "role": "approver"
  },
  "needs": [
    "string"
  ],
  "slug": "string",
  "hooks": {
    "onFailure": [
      {
        "action": [
          "void_loan"
        ],
        "description": "Ação de cancelamento de empréstimo."
      }
    ],
    "onStart": [
      {
        "action": [
          "mark_loan_as_pending"
        ],
        "description": "Marcar o empréstimo como pendente."
      }
    ]
  }
}