SettingsSteps

Configurações do modo passo a passo

title

string

Título identificador do passo.

type

enum<string>

Tipo identificador do passo.

Available options:

signature,

disburse,

document_verification,

pass,

valid_employment,

custom_request,

attachments_to_request

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.

Show child attributes

methodData.schema

object

Configuração do responsável pela assinatura.

• signature
• document_verification
• valid_employment
• custom_request
• unico
• attachments_to_request

Show child attributes

methodData.schema.type

enum<string>

Tipo responsável pela assinatura.

Available options:

operator,

customer

methodData.schema.role

enum<string>

Papel assumido.

Available options:

approver,

financial,

administrator,

backoffice

Example:

"approver"

needs

string[]

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

Slug do passo (step) dependente.

slug

string

Identificador único do passo.

hooks

object

Definição de hooks da esteira.

Show child attributes

hooks.onFailure

enum<string>[]

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

Available options:

void_loan,

cancel_loan

Example:

["void_loan"]

onStart

enum<string>[]

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

Available options:

mark_loan_as_pending

Example:

["mark_loan_as_pending"]