Create a Signup Report

A signup report is the standard and most typical way to create a new report. This should be used when a borrower is signing into a new financial institution and does not have other incomplete reports.

1. Signup Request

URL: POST /create_and_send_customer_url

Name	Type	Required	Allowed Values	Length	Description
request_id	String	Yes		64	Unique ID for API request. Can be any unique ID generated by you.
customer_id	String	Yes		64	Unique ID for the borrower in external system.
report_type	String	No	Signup	128	Default 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_url	String	No		64	Link for loan app which can also be included in email and SMS sent to customer
is_contact_customer	boolean	No		64	Default value: true. If true, we will send a sign-in link to borrower via email and SMS*
loan_id	String	Yes		64	Unique Loan ID generated from LMS or LOS system
lead_data.first_name	String	Yes		64	Customer’s first name
lead_data.last_name	String	Yes		64	Customer’s last name
lead_data.dob	String	Yes			Customer’s date of birth. Format: yyyy-mm-dd.
lead_data.email	String	Yes		128	Customer’s email address. Format is abcd@abcd.abc
lead_data.primary_phone	String	Yes			Customer’s primary cell phone number. Format: All numeric digits; no special characters
lead_data.employment_name	String	Yes		64	Name of customer’s current employer
lead_data.employment_phone	String	Yes		32	Phone number of the customer’s employer. Format: All numeric digits; no special characters
lead_data.net_income	Float	Yes			Customer’s net monthly income
lead_data.pay_frequency	String	Yes	["Weekly", "Bi-Weekly", "Twice-Monthly", "Semi-Monthly", "Monthly"]	50	Customer’s pay schedule
lead_data.last_paydate	String	Yes		10	Customer’s most recent pay date. Format: yyyy-mm-dd.
lead_data.next_paydate	String	Yes		10	Customer’s next pay date. Format: yyyy-mm-dd.
lead_data.bank_account_number	String	Yes		100	Customer’s bank account number
lead_data.bank_routing_number	String	Yes		9	American Bankers Association (ABA) routing number for the customer’s bank. Format: All digits; no dashes (nnnnnnnnn)
lead_data.requested_amount	Float	Yes			Requested loan amount in USD, including dollars and cents

2. Signup Response

Name	Type	Required	Allowed Values	Length	Description
url	String	Yes		300	Borrower portal link for bank login
report_id	String	Yes		6	Unique report ID created by Lokyata

3. Example JSON Request

Request Header:

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

Payload:

{
  "request_id": "REQ-25",
  "customer_id": "8",
  "loan_id": "Loan1",
  "loan_application_url": "www.example.com/apply/12345",
  "is_contact_customer": true,
  "lead_data": {
    "requested_amount": 500,
    "dob": "1900-01-01",
    "first_name": "Charlie",
    "last_name": "Kelley",
    "primary_phone": "3014481234",
    "email": "test@lokyata.com",
    "employment_name": "Paddy's Pub",
    "employment_phone": "3014485678",
    "pay_frequency": "Weekly",
    "last_paydate": "1990-01-01",
    "next_paydate": "1990-01-01",
    "net_income": 1500,
    "bank_routing_number": "123456789",
    "bank_account_number": "123456"
  }
}

4. Example JSON Response

{
  "url": "https://banklogin.app/VEJJFC",
  "report_id": "VEJJFC"
}