Skip to main content

Create a Reauth report

A re-authorization, or “reauth” report, should be used when a borrower is having trouble signing into their institution, or signed into the wrong institution, and wants to start the authentication process over with a new institution. Creating a reauth report deactivates all incomplete reports for that borrower and creates a new sign-in link.

  1. Reauth Request#

URL: POST /create_and_send_customer_url

NameTypeRequiredAllowed ValuesLengthDescription
request_idStringYes64Unique ID for API request. Can be any unique ID generated by you.
customer_idStringYes64Unique ID for the borrower in external system.
report_idStringYes6Source report_id for existing report where sign-in process failed
report_typeStringNoReauth128Default value: Signup. What type of new report to create. Signup: Borrower signs into their bank account. Reauth - Cancel all open reports and create a new Signup report. Refresh - Pull latest data for an existing connection
loan_application_urlStringNo64Link for loan app which can also be included in email and SMS sent to customer
is_contact_customerStringNo64Default value: true. If true, we will send a sign-in link to borrower via email and SMS

Note that by default, in the sandbox environment, we will not contact the customer, regardless of the value of is_contact_customer parameter. Lokyata can enable customer contact in sandbox environment upon request.

  1. Reauth Response#

NameTypeRequiredAllowed ValuesLengthDescription
urlStringYes300Borrower portal link for bank login
report_idStringYes6Unique report ID created by Lokyata

  1. Example JSON Request#

Request Header:

{  "x-api-key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",  "Content-Type": "application/json"}


{  "request_id": "REQ-21",  "customer_id": "8",  "report_id": "ZJKPAF",  "loan_application_url": "",  "is_contact_customer": true,  "report_type": "Reauth"}

  1. Example JSON Response#

{  "url": "",  "report_id": "AEJJFC"}