# Criar link de onboarding

Esta seção tem como objetivo detalhar a criação de links de onboarding.

# Requisição

Query string params

# origin String Obrigatório
Parâmetro que define a origem do onboarding. Deve ser definido como TRUST.

Body

# transactionTemplateId String Obrigatório
Id do modelo de consulta (nesse caso o query string origin deve estar como TRUST) ou id do relatório (suporte ao fluxo legado).
# type String Obrigatório
Tipo de onboarding. Possíveis valores: PF, PJ ou PF_PF.
# templateId String Opcional
Id do template de onboarding a ser utilizado, caso não informado, será utilizado o template padrão. Para solicitar um template de onboarding entre em contato com nosso time.
# email String Opcional
E-mail para o envio do link do onboarding.
# smsPhoneNumber String Opcional
Número de telefone para o envio do SMS com o link do onboarding.
# noExpire Boolean Opcional
Define se o link pode ser utilizado apenas uma ou múltiplas vezes. Quando true, o link aceitará múltiplos cadastros. O padrão é false.
# variables Object Opcional
Informações que o usuário deseja trazer para dentro do template de onboarding para preenchimento dos campos. Limite: 20 atributos.
# attributes Array of objects Opcional
Informações adicionais vinculadas ao link de onboarding.
Atributos de attributes

# cpf String Opcional

Deve ser informado quando deseja travar o cadastro apenas para o CPF informado.

# cnpj String Opcional

Deve ser informado quando deseja travar o cadastro apenas para o CNPJ informado.

Body - atributos exclusivos para o type PF_PF

# transactionPFTemplateId String Obrigatório
Id do modelo de consulta ou id do relatório (suporte ao fluxo legado) a ser utilizado no onboarding da(s) pessoa(s) relacionada(s).

Body - atributos exclusivos para o type PJ

# transactionQsaTemplateId String Obrigatório
Id do modelo de consulta ou id do relatório (suporte ao fluxo legado) a ser utilizado no onboarding dos sócios.

# Resposta

# requestId String Obrigatório
identificador único da requisição realizada.
# id String Obrigatório
identificador único do onboarding criado.
# url String Obrigatório
Link para acessar o onboarding.