Lili API Documentation
/
Application API
/
Download Bank Letter

Application API (v2.0.0)

Lili Server API Swagger documentation

Download OpenAPI description
index.json
index.yaml
Overview
URL

https://lili.co

Lili Dev Resources

dev-resources@lili.co

Languages
Servers
Lili Server

https://sandbox.lili.co/

Create Application

Request

The Create Application API is used to create a new Application in the Lili platform.

The respon contains a UUID representing the applicant that was created in the Lili platform, and a URL that allows initializing the application process with the pre-filled information.

Bodyapplication/json
emailstring(email)required

The unique ID of the webhook

phoneNumberstring

Customer phone number. E.164 format.

ssnstring(regex)^(?!666|000|9\d{2})\d{3}-\d{2}-(?!0{4})\d{4}$...

Customer SSN

Example: "XXX-XX-XXXX"
birthDatestring(date)

Customer birth date

firstNamestring

Customer first name

lastNamestring

Customer last name

line1string

Customer address line1

line2string

Customer address line2

citystring[ 1 .. 30 ] characters

Customer address city

statestring

Customer address 2 letter state code

Example: "NY"
countrystring

Customer country of residence (Alpha 2, ISO 3166 format)

Example: "NY"
postalCodestring(regex)^\d{5}(-\d{4})?$

Customer address postal code

Example: "XXXXX"
einstring(regex)^(0[1-6]|1[0-6]|2[0-7]|3[0-9]|4[0-8]|5[0-9]|6...

Business EIN

businessNamestring

Business name

businessLine1string

Business address line 1

businessLine2string

Business address line 2

businessCitystring[ 1 .. 30 ] characters

Business address city

businessStatestring

Business address 2 letter state code

Example: "NY"
businessPostalCodestring(regex)^\d{5}(-\d{4})?$

Business address postal code

Example: "XXXXX"
businessTypeany

Incorporation type of the business

Enum"DBA""LLC""MMLLC""GENERAL_PARTNERSHIP""LLP""S_CORP""SSN""C_CORP"
incorporationStatestring

State the business was incorporated in

uniqueIdstring

Unique ID to be used by the partner to identify the customer

dunsstring

Business DUNS number

passportNumberstring

Passport number

idGovNumberstring

Non US customer National ID number

idCountrystring

National ID country (Alpha 2, ISO 3166 format). Note that if a passport number is supplied, this is the passport issuance country

idExpirationDatestring

National ID expiration date. Note that if passport number is supplied, this is the passport expiration date

documentUrlsArray of strings or null

A list of URLs containing the business documents of the customer

documentDataListArray of objects(DocumentData)

A list of URLs containing the business documents of the customer

curl -i -X PUT \
  https://sandbox.lili.co/lili/api/v1/lead \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "user@example.com",
    "phoneNumber": "string",
    "ssn": "XXX-XX-XXXX",
    "birthDate": "2019-08-24",
    "firstName": "string",
    "lastName": "string",
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "NY",
    "country": "NY",
    "postalCode": "XXXXX",
    "ein": "/regex/",
    "businessName": "string",
    "businessLine1": "string",
    "businessLine2": "string",
    "businessCity": "string",
    "businessState": "NY",
    "businessPostalCode": "XXXXX",
    "businessType": "DBA",
    "incorporationState": "string",
    "uniqueId": "string",
    "duns": "string",
    "passportNumber": "string",
    "idGovNumber": "string",
    "idCountry": "string",
    "idExpirationDate": "string",
    "documentUrls": [
      "string"
    ],
    "documentDataList": [
      {
        "content": "string",
        "contentType": "string",
        "fileName": "string"
      }
    ]
  }'

Responses

Created with a URL of the onboarding link

Bodyapplication/json
customerIdstring(uuid)required

A unique ID for the customer (same as person ID)

locationstring(uri)required

A unique URL to be used by the customer for a personalized application flow

tokenstringrequired

The token that should be sent to Lili Connect UI

partnerSuppliedIdstring

The uniqueID provided by the partner in the Create Application call. Empty if none was supplied

personIdstring(uuid)Deprecatedrequired

The unique ID of the registered person

Response
application/json
{
  "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  "location": "http://example.com",
  "token": "string",
  "partnerSuppliedId": "string",
  "personId": "f3e5ff26-28ff-4cd6-9b1b-e303a185a13a"
}

Download Bank Letter

Request

Gets a PDF containing a bank letter for a customer

Path
customerIdstringrequired

The customer ID, as provided in the create lead response

curl -i -X GET \
  'https://sandbox.lili.co/lili/api/v1/{customerId}/bankLetter' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Register a payment transaction

Request

Creates a payment notification in the Lili system

Bodyapplication/json
customerIdstring
amountnumber
effectiveDatestring(date-time)
payeeNamestring
receiverAccountNumberstring
traceNumberstring
originatorRoutingNumberstring
originatorAccountNumberstring
curl -i -X PUT \
  https://sandbox.lili.co/lili/api/v1/payments \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "customerId": "string",
    "amount": 0,
    "effectiveDate": "2019-08-24T14:15:22Z",
    "payeeName": "string",
    "receiverAccountNumber": "string",
    "traceNumber": "string",
    "originatorRoutingNumber": "string",
    "originatorAccountNumber": "string"
  }'
Copyright © Lili App Inc. All rights reserved.