NAV Navbar

Introduction

This API is used for integration of a user experience client for making loans, purchases and general profile (PII) data storage and compliance for PCI, CCPA and GDPR for merchant websites. PII data is sheltered from the merchant for compliance reasons, but is exposed to marketplace owner. Payment facilitation is integrated underneighth this API set in order to process transactions on behalf of merchants.

Integration documentation for embedding the Know client into your webpage can be found below.

Embedded Know Client

Use the custom HTML tags below to embed and launch the client directly from a webpage. This form of integration gives the best user experience. A live demonstration of this integration can be seen here: https://elementalknowledge.myshopify.com/collections/all.

When embedded into your webpage, the tags below in combination with attributes listed will launch the client with the desired behavior. There are 3 different client configurations supported.

Client Configuration Description
loan launch the client with Buy Now Pay Later payment option(s)
checkout launch the client with credit and debit card payment option only
login launch the client for single sign on

eg:

<know-loan ....attributes list....>Split into low Payments</know-loan>

<know-checkout ....attributes list....>Buy Now</know-checkout>

<know-login ....attributes list....>Login/know-login>

Launch Know-Loan client

Add this line to the page header:

<head>
...
<script src="https://www.goknow.me/app/know.js" defer></script>
</head>

Anywhere in the page body add the callback methods. These methods are just examples, it's up to you to adjust the functionality. Notice the recordToken(token) method will get called with the token (loan id) as a parameter. It is intended to be disbursed by using the loan endpoint.:

<body>
...

<script>
function recordToken(token) {
  //do whatever with the loan token
}

function recordApplicationToken(token,approved) {
  //do whatever with the application token and approval status
}

function recordOrderToken(token) {
  //do whatever with the order token
}

function loancomplete() {
  //
  //loan approved, do some operation
  //the window has not been closed yet, still waiting on consumer to close it
  //if you use this function, you don't need to record the token on the 
  //complete() function

  //get the token
  var app=document.getElementById('know-checkout-application'); 
  var response = app.getAttribute('response');
  if(response!=null) {
    var data = JSON.parse(response);
    //token resides in data.token
    recordToken(data.token);
  }
}

function loandisburse() {
  //
  //loan approved, do some operation
  //the window has not been closed yet, we need to respond to the 
  //window with a disburse success or fail
  //if disburse is happening by the server, then you need to respond
  //to the knowLoanDisburseStatus function as shown below

  //get the token
  var app=document.getElementById('know-checkout-application'); 
  var response = app.getAttribute('response');
  if(response!=null) {
    var data = JSON.parse(response);
    //token resides in data.token
    knowLoanDisburseStatus(data.token,true);
  }
}

function complete(product_id) {
  //
  //loan approved, change the button now
  //

  var widget_button=document.getElementById('know_loan_'+product_id); 
  widget_button.innerHTML=`
    <div style="color: white; font-weight: bold;">
      <table>
        <tr with=100%>
          <td bgcolor=black id="know_background_${product_id}">
            <center>Ordered</center>
          </td>
        </tr>
      </table>
    </div>
  `;
  var widget_background=document.getElementById('know_background_'+product_id);
  widget_background.setAttribute('bgcolor','grey');
}

function applicationcomplete() {
  //
  //customer finished the loan application
  //
  var app=document.getElementById('know-checkout-application'); 
  var response = app.getAttribute('response');
  if(response!=null) {
    var data = JSON.parse(response);
    //token resides in data.token
    //approval (true/false) resides in data.approved
    recordApplicationToken(data.token,data.approved);
  }
}

function ordercomplete() {
  //
  //customer placed an order
  //
  var app=document.getElementById('know-checkout-application'); 
  var response = app.getAttribute('response');
  if(response!=null) {
    var data = JSON.parse(response);
    //token resides in data.token
    recordOrderToken(data.token);
  }
}

function incomplete() {
  //
  //customer never filled out the form
  //
}
</script>

Put the customizable button to launch the know client anywhere in the page body:

<know-loan
  title="Buy Now, Pay Later"
  description="Leather Couch"
  quantity="1"
  image="https://www.clipartkey.com/mpngs/m/141-1418020_sofa-vector-sofa-furniture-png.png"
  tax_rate="0"
  shipping="0"
  shippable="true"
  currency="usd"
  email_receipt="true"
  sku="1234567"
  email_required="true"
  phone_required="true"
  id="know_loan_leather_couch"
  oncomplete="complete('leather_couch');"
  onloancomplete="loancomplete();"
  onloandisburse="loandisburse();"
  onapplicationcomplete="applicationcomplete();"
  onordercomplete="ordercomplete();"
  onincomplete="incomplete();"
  cost="1200.00"
  style="color: white; font-weight: bold;">

    <div>
      <table>
        <tr with=100%>
          <td bgcolor=black id="know_background_leather_couch">
            <center>Split Into Payments</center>
          </td>
        </tr>
      </table>
    </div>

</know-loan>


...
</body>

The loan client should be used when directing a consumer to a Buy Now Pay Later or unsecured short term loan payment option. The consumer will be required to submit some personal information and will ultimately be presented with a list of Buy Now Pay Later, or short term loan options to complete the purchase. Some options may require a partial payment with credit or debit card.

HTML TAG
know-loan
Attributes
title string
Text to show in the title bar of client.
description string
A brief description of the item or cart contents. Only the first 30 or so characters will be displayed in the client.
quantity integer
The number of items that are being purchased if this is a single item. If an entire shopping basket with a number of items in it are being purchased, then quantity should be 1 or omitted.
image string
A URL (RFC 3986 URL) linking to an image representing what is being purchased.
shippable boolean
Defines if the item or basket of items is shippable. Values should be true or false. If omitted, the default value is false.
cost float
The cost (excluding shipping, tip, tax) of the item or shopping cart of items being purchased.
currency string
Currency abbreviation (lower case ISO 4217). For example the United States would be usd.
tax_rate float
Sales tax expressed as a percentage value. For example, if the sales tax rate is 9%, then this value should be 9.
shipping float
Total cost of shipping.
More attributes
site_id string

otp_auth_id string

otp_auth_key string

otp_auth_secret string

phone string

email string

identifier string - enum

background_color string

foreground_color string

no_background_click_close boolean

no_auto_scroll boolean

no_mobile_keyboard boolean

first_name string

last_name string

address_line1 string

address_line2 string

address_state string

address_city string

address_zip string

address_country string

logo string

rep_id string

email_receipt boolean

email_required boolean

phone_required boolean

sku string

transaction_id string

tippable boolean

processor_access_id string

fulfillment_access_id string

disburse boolean

no_splash_screen boolean

dob string

ssn string

ssn_last4 string

monthly_income integer

monthly_expenses integer

employer_name string

employer_duration string

service_date string

hold_approval_until string

consumer_percentage_of_fee float

onscrolloverflow string - javascript code

oncomplete string - javascript code

onincomplete string - javascript code

oninit string - javascript code

onordercomplete string - javascript code

onloancomplete string - javascript code

onloandisburse string - javascript code

onapplicationcomplete string - javascript code

Launch Know-Checkout Client

Add this line to the page header:

<head>
...
<script src="https://www.goknow.me/app/know.js" defer></script>
</head>

Anywhere in the page body add the callback methods. These methods are just examples, it's up to you to adjust the functionality.:

<body>
...

<script>
function complete(product_id) {
  //
  //order finished, change the button now
  //

  var widget_button=document.getElementById('know_checkout_'+product_id); 
  widget_button.innerHTML=`
    <div style="color: white; font-weight: bold;">
      <table>
        <tr with=100%>
          <td bgcolor=black id="know_background_${product_id}">
            <center>Ordered</center>
          </td>
        </tr>
      </table>
    </div>
  `;
  var widget_background=document.getElementById('know_background_'+product_id);
  widget_background.setAttribute('bgcolor','grey');
}

function ordercomplete() {
  //
  //customer never filled out the form
  //
  var app=document.getElementById('know-checkout-application'); 
  var response = app.getAttribute('response');
  if(response!=null) {
    var data = JSON.parse(response);
    //token resides in data.token
    recordOrderToken(data.token);
  }
}

function incomplete() {
  //
  //customer never filled out the form
  //
}
</script>

Put the customizable button to launch the know client anywhere in the page body:

<know-checkout
  title="EKI Checkout"
  description="Leather Couch"
  quantity="1"
  image="https://www.clipartkey.com/mpngs/m/141-1418020_sofa-vector-sofa-furniture-png.png"
  tax_rate="0"
  shipping="0"
  shippable="true"
  currency="usd"
  email_receipt="true"
  sku="1234567"
  email_required="true"
  phone_required="true"
  id="know_checkout_leather_couch"
  oncomplete="complete('leather_couch');"
  onordercomplete="ordercomplete();"
  onincomplete="incomplete();"
  cost="1200.00"
  style="color: white; font-weight: bold;">

    <div>
      <table>
        <tr with=100%>
          <td bgcolor=black id="know_background_leather_couch">
            <center>Buy Now</center>
          </td>
        </tr>
      </table>
    </div>

</know-loan>


...
</body>

The checkout client should be used when collecting payment in full with credit or debit card.

HTML TAG
know-checkout
Attributes
title string
Text to show in the title bar of client.
description string
A brief description of the item or cart contents. Only the first 30 or so characters will be displayed in the client.
quantity integer
The number of items that are being purchased if this is a single item. If an entire shopping basket with a number of items in it are being purchased, then quantity should be 1 or omitted.
image string
A URL (RFC 3986 URL) linking to an image representing what is being purchased.
shippable boolean
Defines if the item or basket of items is shippable. Values should be true or false. If omitted, the default value is false.
cost float
The cost (excluding shipping, tip, tax) of the item or shopping cart of items being purchased.
currency string
Currency abbreviation (lower case ISO 4217). For example the United States would be usd.
tax_rate float
Sales tax expressed as a percentage value. For example, if the sales tax rate is 9%, then this value should be 9.
shipping float
Total cost of shipping.
More attributes
site_id string

otp_auth_id string

otp_auth_key string

otp_auth_secret string

phone string

email string

identifier string - enum

background_color string

foreground_color string

no_background_click_close boolean

no_auto_scroll boolean

no_mobile_keyboard boolean

first_name string

last_name string

address_line1 string

address_line2 string

address_state string

address_city string

address_zip string

address_country string

logo string

rep_id string

email_receipt boolean

email_required boolean

phone_required boolean

sku string

transaction_id string

tippable boolean

processor_access_id string

fulfillment_access_id string

onscrolloverflow string - javascript code

oncomplete string - javascript code

onincomplete string - javascript code

oninit string - javascript code

onordercomplete string - javascript code

Launch Know-Login Client

Add this line to the page header:

<head>
...
<script src="https://www.goknow.me/app/know.js" defer></script>
</head>

Anywhere in the page body add the callback methods. These methods are just examples, it's up to you to adjust the functionality.:

<body>
...

<script>
function complete() {
  //
  //login completed
  //
}

function incomplete() {
  //
  //customer failed login
  //
}
</script>

Put the customizable button to launch the know client anywhere in the page body:

<know-login
  title="Sign Up/Sign In"
  oncomplete="complete();"
  onincomplete="incomplete();"
  style="color: white; font-weight: bold;">

    <div>
      <table>
        <tr with=100%>
          <td bgcolor=black>
            <center>Login</center>
          </td>
        </tr>
      </table>
    </div>

</know-loan>


...
</body>

The login client is used for a single sign-on experience when integrated with a website.

HTML TAG
know-login
Attributes
title string
Text to show in the title bar of client.
More attributes
site_id string

otp_auth_id string

otp_auth_key string

otp_auth_secret string

phone string

email string

identifier string - enum

background_color string

foreground_color string

no_background_click_close boolean

no_auto_scroll boolean

no_mobile_keyboard boolean

onscrolloverflow string - javascript code

oncomplete string - javascript code

onincomplete string - javascript code

oninit string - javascript code

onregistered string - javascript code

Hosted Know Client

Create a URL and simply direct consumers to it like a hosted payments page. Return URLs are used to direct consumers back to a website for proper user experience. There are a few special parameters that can be included into your parameter list to help better control the integration and flow of the user experience.

If successful_loan_url, successful_order_url, or failure_url are defined, then the user experience will be forwarded to those url's upon completion of the Know client. In the case of success, an extra parameter will be appended to the respective URL. In the case of successful_loan_url, loan_id will always be appended, in the case of successful_order_url, order_id will be appended.

The order_id or loan_id parameter can be validated against the /v1/loans or /v1/orders endpoints if needed.

It is also possible to put the hosted know client in an iframe element. Just refer the the client launch URL when creating the iframe on the webpate. In this case, cross-origin communication is used to receive responses from the embedded iframe that is hosting the client.

When using the hosted client, create the launch URL by simply appending attributes:

https://{domain}/launch/v1/client/{client-type}?form-encoded-params

domain Description
www.goknow.me default
custom must request a custom launch domain from Know
client-type Description
loan launch the client with Buy Now Pay Later payment option(s)
checkout launch the client with credit and debit card payment option only
login launch the client for single sign on

eg:

https://www.goknow.me/launch/v1/client/loan?cost=1200&title=Buy%20Now%20Pay%20Later&description=Leather%20Couch&disburse=true

In order to simplify the URL creation, it is possible to use the /v1/sessions endpoint to bundle parameters and receive a configured launch URL. Any parameters could also be sent to a configured launch URL by simply appending them to the URL, configured parameters always take precedence in that case. The /v1/sessions endpoint also allows an additional security paramers of defining a TTL (Time To Live) for the configured URL.

Launch Hosted Loan Client

Add this to your webpage:

<a href=
  "https://www.goknow.me/launch/v1/client/loan?cost=1200&title=Buy%20Now%20Pay%20Later&description=Leather%20Couch&disburse=true">
  Split into low Payments
</a>

The loan client should be used when directing a consumer to a Buy Now Pay Later or unsecured short term loan payment option. The consumer will be required to submit some personal information and will ultimately be presented with a list of Buy Now Pay Later, or short term loan options to complete the purchase. Some options may require a partial payment with credit or debit card.

URL Description
https://www.goknow.me/launch/v1/client/loan default loan client
https://{domain}/launch/v1/client/loan choose a custom domain to use

Append the attributes below to the launch domain to get the desired behaveior for the loan client.

Parameters
title string
Text to show in the title bar of client.
description string
A brief description of the item or cart contents. Only the first 30 or so characters will be displayed in the client.
quantity integer
The number of items that are being purchased if this is a single item. If an entire shopping basket with a number of items in it are being purchased, then quantity should be 1 or omitted.
image string
A URL (RFC 3986 URL) linking to an image representing what is being purchased.
shippable boolean
Defines if the item or basket of items is shippable. Values should be true or false. If omitted, the default value is false.
cost float
The cost (excluding shipping, tip, tax) of the item or shopping cart of items being purchased.
currency string
Currency abbreviation (lower case ISO 4217). For example the United States would be usd.
tax_rate float
Sales tax expressed as a percentage value. For example, if the sales tax rate is 9%, then this value should be 9.
shipping float
Total cost of shipping.
failure_url string
The URL to be directed to upon client being canceled or closed before a successful completion.
*
Any additional custom name/value pair that doesn't conflict with the already defined names.
successful_loan_url string
The URL to be directed to upon successful completion. The loan_id parameter will be appended to this URL query string.
More parameters
site_id string

otp_auth_id string

otp_auth_key string

otp_auth_secret string

phone string

email string

identifier string - enum

background_color string

foreground_color string

no_background_click_close boolean

no_auto_scroll boolean

no_mobile_keyboard boolean

first_name string

last_name string

address_line1 string

address_line2 string

address_state string

address_city string

address_zip string

address_country string

logo string

rep_id string

email_receipt boolean

email_required boolean

phone_required boolean

sku string

transaction_id string

tippable boolean

processor_access_id string

fulfillment_access_id string

disburse boolean

no_splash_screen boolean

dob string

ssn string

ssn_last4 string

monthly_income integer

monthly_expenses integer

employer_name string

employer_duration string

service_date string

hold_approval_until string

consumer_percentage_of_fee float

Launch Hosted Checkout Client

Add this to your webpage:

<a href=
  "https://www.goknow.me/launch/v1/client/checkout?cost=1200&title=Buy%20Now%20Pay%20Later&description=Leather%20Couch">
  Split into low Payments
</a>

The checkout client should be used when collecting payment in full with credit or debit card.

URL Description
https://www.goknow.me/launch/v1/client/checkout default loan client
https://{domain}/launch/v1/client/checkout choose a custom domain to use

Append the attributes below to the launch domain to get the desired behaveior for the checkout client.

Parameters
title string
Text to show in the title bar of client.
description string
A brief description of the item or cart contents. Only the first 30 or so characters will be displayed in the client.
quantity integer
The number of items that are being purchased if this is a single item. If an entire shopping basket with a number of items in it are being purchased, then quantity should be 1 or omitted.
image string
A URL (RFC 3986 URL) linking to an image representing what is being purchased.
shippable boolean
Defines if the item or basket of items is shippable. Values should be true or false. If omitted, the default value is false.
cost float
The cost (excluding shipping, tip, tax) of the item or shopping cart of items being purchased.
currency string
Currency abbreviation (lower case ISO 4217). For example the United States would be usd.
tax_rate float
Sales tax expressed as a percentage value. For example, if the sales tax rate is 9%, then this value should be 9.
shipping float
Total cost of shipping.
failure_url string
The URL to be directed to upon client being canceled or closed before a successful completion.
*
Any additional custom name/value pair that doesn't conflict with the already defined names.
successful_order_url string
The URL to be directed to upon successful completion. The order_id parameter will be appended to this URL query string.
More parameters
site_id string

otp_auth_id string

otp_auth_key string

otp_auth_secret string

phone string

email string

identifier string - enum

background_color string

foreground_color string

no_background_click_close boolean

no_auto_scroll boolean

no_mobile_keyboard boolean

first_name string

last_name string

address_line1 string

address_line2 string

address_state string

address_city string

address_zip string

address_country string

logo string

rep_id string

email_receipt boolean

email_required boolean

phone_required boolean

sku string

transaction_id string

tippable boolean

processor_access_id string

fulfillment_access_id string

Cross-Domain Communication

Implement the message receiver in your parent window. Just add this javascript listener to your webpage:

<script>
//
//listen for messages from the Know client embedded iframe
//
window.onmessage = function(e){
    if(e.data) {
      try {

        //parse the message
        var d = JSON.parse(e.data);

        if(d.command == "scroll_overflow") {  //scroll overflow happened
          //take overflow action
          //d.data.dx in pixels
          //d.data.dy in pixels
          if(d.data!=null 
              && !isNaN(parseFloat(d.data.dx)) 
              && !isNaN(parseFloat(d.data.dy))) {
            //scroll this window (parent)
            document.body.scrollTop=
              document.body.scrollTop+parseFloat(d.data.dy);
          }
        } else if(data.command == "close") {  //consumer closed client
          if(d.data!=null) {
            //the child iframe was closed by the consumer
            //d.data.completed (boolean true/false)
            //d.data.params.{page params}
            //
            //do something now like close delete the child iframe
          }
        } else if(data.command == "loan_complete") {  //loan completed
          if(d.data!=null) {
            //the loan application has been completed and the
            //terms have been accepted by the consumer
            //d.data.loan_id (string loan_id)
            //d.data.params.{page params}
            //
            //do something with the loan_id, such as call the 
            // /v1/loans/{loan_id}/disburse  endpoint
          }
        } else if(data.command == "order_complete") {  //order completed
          if(d.data!=null) {
            //the order (checkout) has been completed
            //d.data.order_id (string order_id)
            //d.data.params.{page params}
            //
            //do something with the order_id
          }
        } else if(data.command == "application_complete") {  //loan application completed
          if(d.data!=null) {
            //the loan application has been completed
            //but the consumer has not yet agreed to 
            //the terms yet.
            //d.data.application_id (string application_id)
            //d.data.approved (boolean approval status)
            //d.data.params.{page params}
            //
            //do something with the application_id
            //do something with the approval status (approved)
          }
        }
      } catch(e) {
      }
    }
};
</script>

When using the client in an embedded iframe element on your webpage, it will be important to receive messages from that iframe as to the state of the client. For example, when the consumer closes out of it, or when the consumer finishes the application and is approved or has completed an order, the hosted client iframe will send messages to the parent window so that the parent can take the next actions.

You may chose not to define successful_loan_url, successful_order_url, or failure_url when using the embedded iframe client approach.

When creating the launch URL with attributes, it is OK to add your own custom attributes to this list of attributes. The entire attribute set (including your custom ones) will be returned in cross-domain-messages params object in all message commands except scroll_overflow

The message that is passed to the parent contains a JSON object with the following structure:

Attributes
command string - enum
The type of message being sent from the client. Possible values are scroll_overflow, close, loan_complete, application_complete, order_complete.
data hash
Data associated with the type of command.

Some example scenarios conlude:

Scenario Command Message Examples
Customer scrolls the hosted client iframe beyond the extents scroll_overflow {
 "command": "scroll_overflow",
 "data": {
  "dx": "0.0",
  "dy": "3.0"
}
Customer closes/quits the client application before completing it close {
 "command": "close",
 "data": {
  "completed": false,
  "params": {
   site_id:65d0ec47-fca0-42be-946a-6608c22ca5c6,
   external_application_id:123456}
}
Customer closes/quits the client after completing the checkout or loan application and accepting the terms close {
 "command": "close",
 "data": {
  "completed": true,
  "params": {
   "site_id":"65d0ec47-fca0-42be-946a-6608c22ca5c6",
   "external_application_id":"123456"}
}
Customer successfully accepts loan terms loan_complete {
 "command": "loan_complete",
 "data": {
  "loan_id": "65d0ec47-fca0-42be-946a-6608c22ca5c6",
  "params": {
   "site_id":"65d0ec47-fca0-42be-946a-6608c22ca5c6",
   "external_application_id":"123456"}
}
Customer completes loan application application_complete {
 "command": "application_complete",
 "data": {
  "application_id": "65d0ec47-fca0-42be-946a-6608c22ca5c6",
  "approved": true,
  "params": {
   "site_id":"65d0ec47-fca0-42be-946a-6608c22ca5c6",
   "external_application_id":"123456"}
}
Customer completes the checkout order_complete {
 "command": "order_complete",
 "data": {
  "order_id": "65d0ec47-fca0-42be-946a-6608c22ca5c6",
  "params": {
   "site_id":"65d0ec47-fca0-42be-946a-6608c22ca5c6",
   "external_application_id":"123456"}
}

RESTful API

BASE URL

https://api.goknow.me

The Know API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Authentication

AUTHENTICATED REQUEST

$ curl https://api.goknow.me/v1/loans/0a93b291-d04e-4a7b-80f5-13c1450d2873 -X GET  \
  -u 669774a5-dbbc-481f-99ab-8c7c99d5d240:0754cd6b-97f1-4138-b4bf-d78e2ccbf733

Sign up to get your developer identifier. Authentication to the API is performed via HTTP Basic Auth.

Header Key Header Value
Authorization BasicBase64(key:secret)

If you need to authenticate via bearer auth (e.g., for a cross-origin request), use -H "Authorization: Bearer {key}:{secret}" instead of -u {key}:{secret}.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail.

The {key} and {secret} values may be different depending on endpoints being used. Some endpoints require a secret while others may not. Additionally, some endpoints may accept an email address or phone number instead of a RFC-4122 UUID formatted key.

When a phone number or email is used as a key, they will be interpretted in a forgiving way. for example inFO@goknow.ME matches info@goknow.me.

When a phone number or email is used as a key, a header containing your developer identifier is required. e.g: -H "Site-ID: {developer_identifier}.

RESTful Request format

Endpoint request methods can be POST, GET, or DELETE.

When posting (POST) data, all parameters should be passed to the endpoint as standard form-data.

Possible Request Headers

Header Key Mandatory Endpoints Description
Authorization Yes All endpoints except for GET on the /v1/sessions endpoint Basic Authentication with key and secret
Site-ID Yes On POST on the credentials endpoint, The /v1/otp_auths endpoint to specify which site to authenticate to

RESTful Response format

Response Format

Status Code Body Response Params Example
204 None none
200 JSON parameters and values
400,401,404 JSON {"status":"404","err_id":"27","message":"no site found"}

Possible Response Headers

Header Key Description/Value
Date response timestamp
Content-Type text/html
Transfer-Encoding chunked
Connection keep-alive
Server Apache/2.4.46 ()
Access-control-allow-credentials CORs policy for browser integration
Access-control-allow-headers CORs policy for browser integration
Access-control-allow-methods CORs policy for browser integration
Access-control-allow-origin CORs policy for browser integration

Errors

HTTP STATUS CODE SUMMARY
200 - OKEverything worked as expected
204 - OKEverything worked as expected and there is no content
400 - Bad RequestThe request was unacceptable, often due to missing a required parameter
401 - UnauthorizedNot authorized to preform this action or no valid API key/secret was provided
404 - Not FoundThe requested resource doesn't exist

Know uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with Stripe's servers (these are rare).

Some 4xx errors that could be handled programmatically (e.g., a card is declined) include an error code that briefly explains the error reported.

Attributes
status string
HTTP status code.
err_id string
Know error id.
message string
Brief message that explains the error.

Credentials

ENDPOINTS

 GET /v1/credentials
POST /v1/credentials

This is an object that contains your key, secret and consumer identifier that are used for authenticating to these APIs.

You can retrieve the credentials by using the email, phone, or consumer identifier as the key, and the code as the secret.

You request a code by a POST to the credentials using the email, phone, or consumer identifier as the key, and leaving the secret blank.

Method Endpoint Authorization Header Site-ID Header
POST /v1/credentials Authorization: BasicBase64([{email}][{phone}][{id}]:) Site-ID: {site_id}
GET /v1/credentials Authorization: BasicBase64([{email}][{phone}][{id}]:{code})

The credentials object

THE CREDENTIALS OBJECT

{
   "id" : "4f677b16-e308-4886-b56b-0cb0e33f05c4",
   "secret" : "0754cd6b-97f1-4138-b4bf-d78e2ccbf733",
   "key" : "669774a5-dbbc-481f-99ab-8c7c99d5d240"
}
Attributes
id string
Unique consumer identifier (RFC-4122 UUID) that represents the account in the system.
key string
Unique key (RFC-4122 UUID) for the specific site profile being authenticated.
secret string
Secret (RFC-4122 UUID) for the specific site profile being authenticated.

Request a code

POST /v1/credentials

$ curl https://api.goknow.me/v1/credentials -X POST \
  -u you@example.com: \
  -H "Site-ID: a14069da-e3b6-4952-a7f4-e0f44e0efe23"

This will send a 6 digit authentication code to the email address or phone number that can be used for retrieving credentials. If an ID is passed instead of an email or phone number, default email address is used and if an email address does not exist, the default phone number is used to send the code.

Parameters
No parameters.
Returns
Nothing, or returns an error otherwise.

Retrieve credentials

GET /v1/credentials

$ curl https://api.goknow.me/v1/credentials -X GET \
  -u cdougy91@gmail.com:872289

RESPONSE

{
   "id" : "4f677b16-e308-4886-b56b-0cb0e33f05c4",
   "secret" : "0754cd6b-97f1-4138-b4bf-d78e2ccbf733",
   "key" : "669774a5-dbbc-481f-99ab-8c7c99d5d240"
}

Retrieves a key and secret value for a specific consumer id for the email, phone, or consumer id listed. The code is verified with the code sent in the previous POST.

Parameters
No parameters.
Returns
Returns a credentials object for the account that was authenticated in the request, or returns an error otherwise.

Sessions

ENDPOINTS

POST /v1/sessions
 GET /v1/sessions/:id

To get a launch URL for a hosted Know client that is linked to a set launch parameters, you create a session object. You can retrieve individual sessions as well. Sessions are identified by a unique, random ID.

The session object

THE SESSION OBJECT

{
   "params" : {
      "cost" : 1200,
      "site_id" : "b594e32a-c72a-4f1f-a6aa-e77a1758b42b",
      "recipient_id" : "b594e32a-c72a-4f1f-a6aa-e77a1758b42b",
      "description" : "Leather Couch"
   },
   "client" : "loan",
   "launch_url" : "https://www.goknow.me/launch/v1/client/loan?s=65d0ec47-fca0-42be-946a-6608c22ca5c6",
   "ttl" : 60,
   "created" : "2021-09-01 21:04:26", 
   "id" : "65d0ec47-fca0-42be-946a-6608c22ca5c6"
}
Attributes
id string
Unique session id (RFC-4122 UUID).
created string
Formated timestamp (YYYY-MM-DD HH:MM:SS) at session creation.
launch_url string
The launch URL (RFC 3986 URL) of the hosted Know client for this session.
ttl int
The session's time to live in seconds from the time the session is created. If omitted or 0 is specified, the ttl will be infinate.
client string - enum
The type of client to launch. Possible values are loan, checkout, login.
params hash
The attributes that were used to create the client launch URL. This includes any customer attributes that were used also.

Create a session

POST /v1/sessions

$ curl https://api.goknow.me/v1/sessions -X POST  \
  -u 669774a5-dbbc-481f-99ab-8c7c99d5d240:0754cd6b-97f1-4138-b4bf-d78e2ccbf733 \
  -d "ttl=300" \
  -d "client=loan" \
  -d "params[site_id]=b594e32a-c72a-4f1f-a6aa-e77a1758b42b" \
  -d "params[recipient_id]=b594e32a-c72a-4f1f-a6aa-e77a1758b42b" \
  -d "params[transaction_id]=12345678" \
  -d "params[cost]=800" \
  -d "params[disburse]=true" \
  -d "params[description]=Moonlight Electric Invoice" \
  -d "params[image]=https://jdelectric.ca/wp-content/uploads/sites/2195/2016/12/logo-clean.png" \
  -d "params[title]=Break Into Small Payments" \
  -d "params[successful_loan_url]=https://www.thisismyownwebsite123.com/successful_checkout" \
  -d "params[failure_url]=https://www.thisismyownwebsite123.com/failed_checkout" \
  -d "params[referer_required]=false"

RESPONSE

{
   "params" : {
      "cost" : 800,
      "disburse" : true,
      "site_id" : "b594e32a-c72a-4f1f-a6aa-e77a1758b42b",
      "recipient_id" : "b594e32a-c72a-4f1f-a6aa-e77a1758b42b",
      "transaction_id" : "12345678",
      "description" : "Moonlight Electric Invoice",
      "image" : "https://jdelectric.ca/wp-content/uploads/sites/2195/2016/12/logo-clean.png",
      "title" : "Break Into Small Payments",
      "successful_loan_url" : "https://www.thisismyownwebsite123.com/successful_checkout",
      "failure_url" : "https://www.thisismyownwebsite123.com/failed_checkout",
      "referer_required" : false
   },
   "client" : "loan",
   "launch_url" : "https://www.goknow.me/launch/v1/client/loan?s=65d0ec47-fca0-42be-946a-6608c22ca5c6",
   "ttl" : 300,
   "id" : "65d0ec47-fca0-42be-946a-6608c22ca5c6"
}

To get a launch URL for a hosted Know client that is linked to a set launch parameters, you create a session object.

Parameters
ttl int
The session's time to live in seconds from the time the session is created. If omitted or 0 is specified, the ttl will be infinate.
client string - enum
The type of client to launch. Possible values are loan, checkout, login.
params hash
The attributes that were used to create the client launch URL. This includes any customer attributes that were used also.
Returns
Returns the session object if the creation succeeded, or returns an error otherwise.

Retrieve a session

GET /v1/sessions/:id

$ curl https://api.goknow.me/v1/sessions/65d0ec47-fca0-42be-946a-6608c22ca5c6 -X GET

RESPONSE

{
   "params" : {
      "cost" : 800,
      "disburse" : true,
      "site_id" : "b594e32a-c72a-4f1f-a6aa-e77a1758b42b",
      "recipient_id" : "b594e32a-c72a-4f1f-a6aa-e77a1758b42b",
      "transaction_id" : "12345678",
      "description" : "Moonlight Electric Invoice",
      "image" : "https://jdelectric.ca/wp-content/uploads/sites/2195/2016/12/logo-clean.png",
      "title" : "Break Into Small Payments",
      "successful_loan_url" : "https://www.thisismyownwebsite123.com/successful_checkout",
      "failure_url" : "https://www.thisismyownwebsite123.com/failed_checkout",
      "referer_required" : false
   },
   "client" : "loan",
   "launch_url" : "https://www.goknow.me/launch/v1/client/loan?s=65d0ec47-fca0-42be-946a-6608c22ca5c6",
   "ttl" : 300,
   "id" : "65d0ec47-fca0-42be-946a-6608c22ca5c6"
}

Retrieves the details of a session that has previously been created. Supply the unique session ID that was returned from your previous request, and Know will return the corresponding session information. The same information is returned when creating the session.

Parameters
No parameters.
Returns
Returns the session object, or returns an error otherwise.

OTP Authentication

ENDPOINTS

POST /v1/otp_auths
 GET /v1/otp_auths/:id

Create a one time passcode for launching the Know client. This endpoint allows creation of a one time password (OTP) credentials that can be passed to the Know client so a consumer can be logged in automatically during the client launch. A successful POST to the endpoint returns credentials that can be used in a subsequent GET request by the Know client. Both the ttl and created attributes define the window that the credentials will be valid.

A successful GET to the endpoint by the Know client will return access credentials for the consumer for the respective site.

This enpoint requires the Site-ID header:

Method Endpoint Authorization Header Site-ID Header
POST /v1/otp_auths Authorization: BasicBase64(key:secret) Site-ID: site_id
GET /v1/auto_auths/:id Authorization: BasicBase64(key:secret) Site-ID: site_id

The otp_auth object

THE OTP_AUTH OBJECT

{
   "created" : "2021-09-02 00:52:41",
   "ttl" : "100",
   "secret" : "ba595b74-5fe7-4d00-9f0d-17fd58a36566",
   "id" : "6ae2d056-8b90-4e3b-b6e3-8819370540ac",
   "key" : "84970a77-7382-4a4c-b2af-ed01588efb49"
}
Attributes
id string
Unique otp_auth id (RFC-4122 UUID).
created string
Formated timestamp (YYYY-MM-DD HH:MM:SS) at object creation.
ttl int
The session's time to live in seconds from created time. If omitted or 0 is specified, the ttl will be infinate.
key string
Unique key (RFC-4122 UUID) for the specific site profile being authenticated. This expiring key can only be used to authenticate 1 time.
secret string
Secret (RFC-4122 UUID) for the specific site profile being authenticated. This expiring secret can only be used to authenticate 1 time.

Create a otp_auth

POST /v1/otp_auths

$ curl https://api.goknow.me/v1/otp_auths -X POST \
  -H "Site-ID: b594e32a-c72a-4f1f-a6aa-e77a1758b42b"  \
  -u 669774a5-dbbc-481f-99ab-8c7c99d5d240:0754cd6b-97f1-4138-b4bf-d78e2ccbf733 \
  -d "ttl=100" \
  -d "consumer[email][address]=cdougy91@gmail.com"

RESPONSE

{
   "created" : "2021-09-02 00:52:41",
   "ttl" : "100",
   "secret" : "ba595b74-5fe7-4d00-9f0d-17fd58a36566",
   "id" : "6ae2d056-8b90-4e3b-b6e3-8819370540ac",
   "key" : "84970a77-7382-4a4c-b2af-ed01588efb49"
}

To get credentials that can be used for a single authentication, you create a otp_auth object. The consumer phone or email or both is required in order to find the match for the consumer in the Know system.

Parameters
ttl int
The session's time to live in seconds from created time. If omitted or 0 is specified, the ttl will be infinate.
consumer REQUIRED hash
The phone, email of the consumer.
Returns
Returns the otp_auth object if the creation succeeded, or returns an error otherwise.

Retrieve credentials

GET /v1/otp_auths/:id

$ curl https://api.goknow.me/v1/otp_auths/6ae2d056-8b90-4e3b-b6e3-8819370540ac -X GET \
  -H "Site-ID: b594e32a-c72a-4f1f-a6aa-e77a1758b42b" \
  -u 84970a77-7382-4a4c-b2af-ed01588efb49:ba595b74-5fe7-4d00-9f0d-17fd58a36566

RESPONSE

{
   "secret" : "db504124-fbcb-4557-a7e9-6b9da90e3170",
   "id" : "a81ec841-9a4d-4033-bb8d-e6705259c7b1",
   "key" : "f32e14c7-c178-4763-a1c6-94009396686f"
}

Retrieves the credentials that has previously been created. Supply the unique session ID that was returned from your previous request. Authenticate with the key and secret that were returned from the previous request.

Parameters
No parameters.
Returns
Returns access credentials object associated with the consumer for the respective site.

Applications

ENDPOINTS

POST /v1/applications

An aplication may be created in order to see if a consumer is approved for any loan products. You must supply the unique site identifier header Site-ID.

The application object

THE APPLICATION OBJECT

{
   "currency" : "usd",
   "options" : [
      {
         "number_of_payments" : "4",
         "fee_down" : true,
         "interest_amount" : "0.00",
         "fee" : "0.00",
         "now_amount" : "300.00",
         "description" : "Pay 4",
         "frequency" : "bi-weekly",
         "past_due_days" : "6",
         "total_amount" : "1200.00",
         "id" : "1",
         "category" : "BNPL",
         "apr" : "0.00",
         "number_of_loan_payments" : "4",
         "payment_amount" : "300.00",
         "til_url" : "https://www.goknow.me/legal/til?option_id=1&application_id=607c0f33-9114-4f74-b818-a629f91c52dc"
      },
      {
         "number_of_payments" : "6",
         "fee_down" : true,
         "interest_amount" : "27.63",
         "fee" : "0.00",
         "now_amount" : "0.00",
         "description" : "6 Months",
         "frequency" : "monthly",
         "past_due_days" : "15",
         "total_amount" : "1227.63",
         "id" : "2",
         "category" : "6mo",
         "apr" : "8.00",
         "number_of_loan_payments" : "6",
         "payment_amount" : "204.61",
         "til_url" : "https://www.goknow.me/legal/til?option_id=2&application_id=607c0f33-9114-4f74-b818-a629f91c52dc"
      },
      {
         "number_of_payments" : "9",
         "fee_down" : true,
         "interest_amount" : "55.05",
         "fee" : "0.00",
         "now_amount" : "0.00",
         "description" : "9 Months",
         "frequency" : "monthly",
         "past_due_days" : "15",
         "total_amount" : "1255.05",
         "id" : "3",
         "category" : "9mo",
         "apr" : "11.00",
         "number_of_loan_payments" : "9",
         "payment_amount" : "139.46",
         "til_url" : "https://www.goknow.me/legal/til?option_id=3&application_id=607c0f33-9114-4f74-b818-a629f91c52dc"
      },
      {
         "number_of_payments" : "12",
         "fee_down" : true,
         "interest_amount" : "72.17",
         "fee" : "0.00",
         "now_amount" : "0.00",
         "description" : "12 Months",
         "frequency" : "monthly",
         "past_due_days" : "15",
         "total_amount" : "1272.17",
         "id" : "4",
         "category" : "12mo",
         "apr" : "11.00",
         "number_of_loan_payments" : "12",
         "payment_amount" : "106.02",
         "til_url" : "https://www.goknow.me/legal/til?option_id=4&application_id=607c0f33-9114-4f74-b818-a629f91c52dc"
      },
      {
         "number_of_payments" : "18",
         "fee_down" : true,
         "interest_amount" : "166.94",
         "fee" : "0.00",
         "now_amount" : "0.00",
         "description" : "18 Months",
         "frequency" : "monthly",
         "past_due_days" : "15",
         "total_amount" : "1366.94",
         "id" : "5",
         "category" : "18mo",
         "apr" : "17.00",
         "number_of_loan_payments" : "18",
         "payment_amount" : "75.95",
         "til_url" : "https://www.goknow.me/legal/til?option_id=5&application_id=607c0f33-9114-4f74-b818-a629f91c52dc"
      }
   ],
   "status" : {
      "hold_until" : "2022-02-21 00:00:00",
      "approved" : true,
      "decline_reason" : null,
      "message" : "Congratulations, we have some options for you."
   },
   "id" : "607c0f33-9114-4f74-b818-a629f91c52dc",
   "help_url" : "https://www.goknow.me/legal/help.html"
}
Attributes
id string
Id (RFC-4122 UUID) of the application.
currency string
Currency abbreviation (lower case ISO 4217). For example the United States would be usd.
help_url string
A URL (RFC 3986 URL) linking to a web page that may offer some explation on lending policies.
options array
A list of loan products that have been approved for this application.
status hash
The application status details.

Create an application

POST /v1/applications

$ curl https://api.goknow.me/v1/applications -X POST \
  -H "Site-ID: 92e534a4-9de3-4072-944d-b09604d76498" \
  -d "identity[ssn]=999-99-9999" \
  -d "identity[dob]=08-30-1972" \
  -d "payment[amount]=1200" \
  -d "payment[currency]=usd" \
  -d "payment[hold_until]=2022-01-10" \
  -d "email[address]=cdougy91@gmail.com" \
  -d "phone[number]=8656046546" \
  -d "phone[country_code]=1" \
  -d "bill[first_name]=Charles" \
  -d "bill[last_name]=Yeager" \
  -d "bill[address]=7200 Spurlock Dr." \
  -d "bill[city]=Austin" \
  -d "bill[state]=TX" \
  -d "bill[zip]=78731" \
  -d "bill[country]=USA" \
  -d "financials[monthly_income]=1000" \
  -d "app_agreed=true"

RESPONSE

{
   "currency" : "usd",
   "options" : [
      {
         "number_of_payments" : "4",
         "fee_down" : true,
         "interest_amount" : "0.00",
         "fee" : "0.00",
         "now_amount" : "300.00",
         "description" : "Pay 4",
         "frequency" : "bi-weekly",
         "past_due_days" : "6",
         "total_amount" : "1200.00",
         "id" : "1",
         "category" : "BNPL",
         "apr" : "0.00",
         "number_of_loan_payments" : "4",
         "payment_amount" : "300.00",
         "til_url" : "https://www.goknow.me/legal/til?option_id=1&application_id=607c0f33-9114-4f74-b818-a629f91c52dc"
      },
      {
         "number_of_payments" : "6",
         "fee_down" : true,
         "interest_amount" : "27.63",
         "fee" : "0.00",
         "now_amount" : "0.00",
         "description" : "6 Months",
         "frequency" : "monthly",
         "past_due_days" : "15",
         "total_amount" : "1227.63",
         "id" : "2",
         "category" : "6mo",
         "apr" : "8.00",
         "number_of_loan_payments" : "6",
         "payment_amount" : "204.61",
         "til_url" : "https://www.goknow.me/legal/til?option_id=2&application_id=607c0f33-9114-4f74-b818-a629f91c52dc"
      },
      {
         "number_of_payments" : "9",
         "fee_down" : true,
         "interest_amount" : "55.05",
         "fee" : "0.00",
         "now_amount" : "0.00",
         "description" : "9 Months",
         "frequency" : "monthly",
         "past_due_days" : "15",
         "total_amount" : "1255.05",
         "id" : "3",
         "category" : "9mo",
         "apr" : "11.00",
         "number_of_loan_payments" : "9",
         "payment_amount" : "139.46",
         "til_url" : "https://www.goknow.me/legal/til?option_id=3&application_id=607c0f33-9114-4f74-b818-a629f91c52dc"
      },
      {
         "number_of_payments" : "12",
         "fee_down" : true,
         "interest_amount" : "72.17",
         "fee" : "0.00",
         "now_amount" : "0.00",
         "description" : "12 Months",
         "frequency" : "monthly",
         "past_due_days" : "15",
         "total_amount" : "1272.17",
         "id" : "4",
         "category" : "12mo",
         "apr" : "11.00",
         "number_of_loan_payments" : "12",
         "payment_amount" : "106.02",
         "til_url" : "https://www.goknow.me/legal/til?option_id=4&application_id=607c0f33-9114-4f74-b818-a629f91c52dc"
      },
      {
         "number_of_payments" : "18",
         "fee_down" : true,
         "interest_amount" : "166.94",
         "fee" : "0.00",
         "now_amount" : "0.00",
         "description" : "18 Months",
         "frequency" : "monthly",
         "past_due_days" : "15",
         "total_amount" : "1366.94",
         "id" : "5",
         "category" : "18mo",
         "apr" : "17.00",
         "number_of_loan_payments" : "18",
         "payment_amount" : "75.95",
         "til_url" : "https://www.goknow.me/legal/til?option_id=5&application_id=607c0f33-9114-4f74-b818-a629f91c52dc"
      }
   ],
   "status" : {
      "hold_until" : "2022-02-21 00:00:00",
      "approved" : true,
      "decline_reason" : null,
      "message" : "Congratulations, we have some options for you."
   },
   "id" : "607c0f33-9114-4f74-b818-a629f91c52dc",
   "help_url" : "https://www.goknow.me/legal/help.html"
}

To get a list of loan options that a consumer is approved for, you create a applications object.

Parameters
app_agreed REQUIRED boolean
A true/false boolean taht indicates that the consumer has agreed to the terms and conditions of applying for an application witch includes that the consuemr has been made aware that their credit report will be pulled and that their credit will not be affected the the credit inquiry.
identity REQUIRED hash
Consumer identity details.
payment REQUIRED hash
The details of the amount that is being applied for.
phone REQUIRED hash
The details of the consumer phone number.
email REQUIRED hash
The details of the consumer email address.
bill REQUIRED hash
The details of the consumer address.
financials REQUIRED hash
The details of the consumer financial information.
Returns
Returns the application object if the creation succeeded, or returns an error otherwise.

Tils

ENDPOINTS

POST /v1/tils

A TIL may be created in order to present a consumer the proper terms of the lending product that they will agree to and execute. You must supply the unique site identifier header Site-ID.

The til object

THE TIL OBJECT

{
   "payment_3_date" : "03/24/2022",
   "down_payment" : "300.00",
   "execution_date" : "02/08/2022",
   "product_details" : {
      "number_of_payments" : "4",
      "fee_down" : true,
      "interest_amount" : "0.00",
      "fee" : "0.00",
      "now_amount" : "300.00",
      "description" : "Pay 4",
      "frequency" : "bi-weekly",
      "past_due_days" : "6",
      "total_amount" : "1200.00",
      "category" : "BNPL",
      "id" : "1",
      "apr" : "0.00",
      "number_of_loan_payments" : "4",
      "til_url" : "https://www.goknow.me/legal/til?email[address]=cdougy91@gmail.com&payment[currency]=usd&payment[amount]=1200&payment[hold_until]=2022-02-10&site_id=92e534a4-9de3-4072-944d-b09604d76498&category=BNPL&phone[number]=8656046546&phone[country_code]=1&bill[country]=USA&bill[city]=Austin&bill[zip]=78731&bill[address]=7200%20Spurlock%20Dr.&bill[first_name]=Charles&bill[last_name]=Yeager&bill[state]=TX",
      "payment_amount" : "300.00"
   },
   "amount" : "1200.00",
   "maturity_date" : "03/24/2022",
   "html_content" : "<!DOCTYPE html><!--  This site was created in Webflow. http://www.webflow.com  -->\n<!--  Last Published: Thu Dec 02 2021 23:58:02 GMT+0000 (Coordinated Universal Time)  -->\n<html data-wf-page=\"61a94956b2ab647b6cf62ef6\" data-wf-site=\"614364de82ead317140bf4a5\">\n<head>\n  <meta charset=\"utf-8\">\n  <title>TIL</title>\n  <meta content=\"TIL\" property=\"og:title\">\n  <meta content=\"TIL\" property=\"twitter:title\">\n  <meta content=\"width=device-width, initial-scale=1\" name=\"viewport\">\n  <meta content=\"Webflow\" name=\"generator\">\n  <link href=\"css/normalize.css\" rel=\"stylesheet\" type=\"text/css\">\n  <link href=\"css/webflow.css\" rel=\"stylesheet\" type=\"text/css\">\n  <link href=\"css/goknow-me.webflow.css\" rel=\"stylesheet\" type=\"text/css\">\n  <!-- [if lt IE 9]><script src=\"https://cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv.min.js\" type=\"text/javascript\"></script><![endif] -->\n  <script type=\"text/javascript\">!function(o,c){var n=c.documentElement,t=\" w-mod-\";n.className+=t+\"js\",(\"ontouchstart\"in o||o.DocumentTouch&&c instanceof DocumentTouch)&&(n.className+=t+\"touch\")}(window,document);</script>\n  <link href=\"images/favicon.png\" rel=\"shortcut icon\" type=\"image/x-icon\">\n  <link href=\"images/webclip.png\" rel=\"apple-touch-icon\">\n  <script src=\"https://www.google.com/recaptcha/api.js\" type=\"text/javascript\"></script>\n  <style>\n::selection {background: #F2FE9A; color: #1C1D21; text-shadow: none;}\nbody .transition {display: block}\n.w-editor .transition {display: none;}\n.no-scroll-transition {overflow: hidden; position: relative;}\n</style>\n</head>\n<body class=\"body-9\">\n  <main id=\"main-content\" class=\"main-content wf-section\">\n    <div class=\"container-15 w-container\">\n      <div style=\"padding:10px 15px 15px 25px;\">\n        <h2>BNPL/Loan Agreement</h2>\n        <br><strong>1. Promise to Pay.</strong><br>In return for a loan that I have received from one of Know's Bank Partners as indicated on my loan schedule at the bottom of this agreement, I promise to pay U.S. amount plus any Finance Charge to the indicated Bank Partner on the loan schedule. The pronouns \"I\", \"me\" and \"my\" in this Agreement refer to the borrower to whom the loan is made. I understand that my loan and this Agreement may be assigned. Know's Bank Partner(s) or any person who my loan and this Agreement is transferred to is called \"the Loan Holder\" in this Agreement.<br>\n          <br><strong>2. Term.</strong><br>The scheduled term of my loan begins on the calendar day I executed this agreement and ends on the calendar day when the loan and any associated fees or penalties have been repaid in full. I understand that my repayment schedule can be found on the repayment schedule found at the bottom of this agreement. <br>\n\n          <br><strong>3. Interest.</strong><br>I will pay interest as presented on my loan offer and as indicated on my repayment schedule below. This is a simple interest loan, which means that interest accrues daily on the unpaid principal balance, up to the amount of the Finance Charge, until you pay the loan in full.<br>\n\n          <br><strong>4. Payments.</strong><br>My loan requires me to make minimum payments of principal and interest in an amount sufficient to pay off my principal loan balance and any accrued interest by the end of the loan term. I will pay my loan in the amount and on or by the dates indicated in my repayment schedule. My final monthly payment may be more or less than the regularly scheduled monthly payment. My first monthly payment is due, as indicated on my repayment schedule. I will be notified later of the exact date my first monthly payment is due. My remaining monthly payments will be due on the same numerical day of the remaining calendar months.\n\n          If I have agreed to using the Know Buy Now Pay Later service I promise to abide by the payment schedule where as my first payment of twenty-five percent (25%) of the total purchase price will be due upon my entering into this agreement. The remaining three (3) payments of equal payments will be made on the bi-weekly dates indicated on my repayment schedule.<br>\n\n          <br><strong>5. Payment Methods.</strong><br>I will make my payments, using one of the methods made available to me by the Loan Holder, currently debit card and ACH transfer are acceptable methods.<br>\n\n          <br><strong>6. Your Right to Prepay; Refund of Unearned Interest.</strong><br>I may prepay my loan in full at any time without penalty. I am entitled to a refund of any amounts I may pay to the Loan Holder in excess of the remaining principal balance and accrued interest as of the date of prepayment. The Loan Holder will compute the refund as provided in N.J. Stat. Ann. § 17:9A-56. Notwithstanding the foregoing, I agree that the Loan Holder may set off any amounts I am entitled to against any amounts I owe the Loan Holder on any other loan or otherwise.<br>\n\n          <br><strong>7. Failure to Pay as Required.</strong>\n          <br>a. Default. If I do not pay the full amount of each payment on the date it is due, I will be in default.<br>\n          <br>b. Notice of Default. If I am in default, the Loan Holder may send me a notice telling me that if I do not pay the overdue amount by a certain date, the Loan Holder may require me to pay immediately the full amount of my loan, less any unearned interest.<br>\n          <br>c. No Waiver by the Loan Holder. Even if, at a time when I am in default, the Loan Holder does not require me to pay immediately in full as provided in Section 7(b), the Loan Holder will still have the right to do so if I am in default at a later time.<br><br>d. Payment of the Loan Holder's Costs and Expenses. If the Loan Holder has required me to pay immediately in full as described above, the Loan Holder will have the right to be paid back by me for all of its costs and expenses in enforcing this Agreement to the extent not prohibited by applicable law. Those expenses include, for example, reasonable attorneys' fees.<br>\n\n          <br><strong>8. Notices.</strong><br>Unless applicable law requires a different method, any notice that must be given to me under this Agreement may be given, at the Loan Holder's option, electronically, by telephone, in writing by U.S. Mail or by providing it to me in any other manner, in each instance using the contact information the Loan Holder or its representative has on file for me.<br>\n\n          <br><strong>9. Waivers.</strong><br>I waive the rights of Presentment and Notice of Dishonor. \"Presentment\" means the right to require the Loan Holder to demand payment of amounts due. \"Notice of Dishonor\" means the right to require the Loan Holder to give notice to me that amounts due have not been paid.<br>\n\n          <br><strong>10. Loan Charges.</strong><br>If a law, which applies to my loan and which sets maximum loan charges, is finally interpreted so that the interest or other loan charges collected or to be collected in connection with my loan exceeded or exceeds the permitted limit, then: (a) any such loan charge will be reduced by the amount necessary to reduce the charge to the permitted limit; and (b) any sums already collected from me which exceeded permitted limits will be refunded to me, subject to the Loan Holder's right of set off provided in Section 6. The Loan Holder may choose to make this refund by reducing the amount I owe or by making a direct payment to me.<br>\n\n          <br><strong>11. When a Loan Is Made.</strong><br>The Bank who's name is listed on the repayment schedule of this agreement makes a loan to me and I receive a loan from said Bank when the Bank pays the merchant the loan proceeds on my behalf for my purchase of goods or services. After I am approved for a loan and agree to the terms of this Agreement, the Bank who's name appears on the repayment schedule in the agreement may decide not to make me a loan for any reason.<br>\n\n          <br><strong>12. Mandatory Arbitration.</strong><br>THIS SECTION AFFECTS THE BORROWER'S RIGHTS, PLEASE READ CAREFULLY BEFORE AGREEING TO THIS AGREEMENT'S TERMS. Except as otherwise explicitly provided in this Section, I, any Loan Holder, and/or Know Technologies, Inc. (\"Know\") can elect to resolve any dispute or claim relating in any way to my loan or this Agreement that cannot be resolved directly between me, Know, and/or any Loan Holder by binding arbitration under the Consumer Arbitration Rules (\"the Consumer Rules\") of the American Arbitration Association (\"AAA\"), rather than in court. Except as otherwise explicitly provided in this Section, this includes any claims based in contract, statute, tort, fraud, misrepresentation or any other legal theory. The Federal Arbitration Act and federal arbitration law apply to this Agreement. There is no judge or jury in arbitration and court review of an arbitration award is limited, but an arbitrator can award an individual the same damages and relief as a court and must apply and follow the terms of this Agreement as a court would. Any judgment on the award rendered by the arbitrator will be final and may be entered in any court of competent jurisdiction. I UNDERSTAND THAT ABSENT MY CONSENT TO ARBITRATION, I WOULD HAVE THE RIGHT TO SUE IN COURT AND HAVE A TRIAL BY JURY. Either Know, any Loan Holder or I can initiate arbitration through AAA, an alternative dispute resolution provider. Any arbitration will be governed by the then-current Consumer Rules of the AAA, and its Procedures for the Resolution of Disputes through Document Submission (\"Document Submission Procedures\"). The Consumer Rules are available at the AAA website: <a href=\"http://www.adr.org/\" target=\"_blank\">www.adr.org</a>. The Document Submission Procedures are included in the Consumer Rules. My arbitration filing fees will be governed by the Consumer Rules. If it is determined by the arbitrator that I cannot afford such fees, Know and/or the Loan Holder will pay all arbitration fees and expenses. The arbitration will be conducted solely based on written submissions. The arbitration will not involve any personal appearance by the parties or witnesses unless the arbitrator determines that a telephonic or in-person conference or hearing is necessary based on the request of one or more of the parties. The parties grant the arbitrator the exclusive power to rule on any challenges to the requirement for the use of the alternative dispute resolution process in this manner. Know, any Loan Holder and I each agree that any dispute resolution proceedings will be conducted only on an individual basis and not in a class, consolidated or representative action. To the fullest extent permitted by law: (a) no arbitration will be joined with any other; (b) there is no right or authority for any dispute to be arbitrated on a class-action basis or to utilize class action procedures; and (c) there is no right or authority for any dispute to be brought in a purported representative capacity on behalf of the general public or any other persons. If for any reason a claim proceeds in court rather than in arbitration, we each waive any right to a jury trial and agree to proceed only on an individual basis and not in a class, consolidated or representative action. All claims I bring against Know and/or the Loan Holder must be resolved in accordance with this Section. Any claim filed or brought contrary to this Section will be considered improperly filed. Should I file a claim contrary to this Section, Know, and/or any Loan Holder may seek recovery of their attorneys&#x27; fees and costs, provided that Know and/or the Loan Holder has first notified me of the improperly filed claim and I have failed to promptly withdraw the claim. Know, any Loan Holder and I agree that any disputes seeking to enforce or protect, or concerning the validity of intellectual property rights will not be subject to binding arbitration under this Section. In addition, pursuant to Consumer Rules, any party may proceed with their claims in small claims court if that option is available in the applicable jurisdiction and the amount in controversy falls within the small claims court's jurisdictional limits. If any portion of this Section on mandatory arbitration is deemed invalid or unenforceable, the entire arbitration section will be deemed null and void. No portion of this Section on mandatory arbitration may be amended, severed, or waived absent a written agreement signed by all parties.<br>\n\n          <br><strong>13. Other Terms.</strong><br>This Agreement is governed by the laws of the United States of America, Texas, and, only to the extent required by applicable law, the laws of the jurisdiction where I reside, and not the conflicts of law principles of any jurisdiction. No modification to this Agreement is effective unless made in writing and signed by the Loan Holder and me. If any provision of this Agreement is found to be invalid or unenforceable, all other provisions will be enforced and construed as if the invalid provisions were never a part of this Agreement.<br>\n\n          <br>See Know's Terms of Service and Privacy Policy for additional information.<br>\n\n          <br><strong>14. Covered Borrowers under the Military Lending Act.</strong><br>Federal law provides important protections to members of the Armed Forces and their dependents relating to extensions of consumer credit. In general, the cost of consumer credit to a member of the Armed Forces and his or her dependent may not exceed an annual percentage rate of 36 percent. This rate must include, as applicable to the credit transaction or account: The costs associated with credit insurance premiums; fees for ancillary products sold in connection with the credit transaction; any application fee charged (other than certain application fees for specified credit transactions or accounts); and any participation fee charged (other than certain participation fees for a credit card account).<br><br>Notwithstanding any other provision of this Agreement, Sections 9 and 12 shall not apply to a \"covered borrower\" under the Military Lending Act, as defined in 32 C.F.R. § 232.3(g). Furthermore, nothing in this Agreement shall be construed as applying to a covered borrower to the extent inconsistent with the Military Lending Act.<br><br>To obtain an oral statement regarding the Military Annual Percentage Rate and a description of the payment obligation, covered borrowers may call the following toll-free phone number: (855) 411-2372<br>\n\n          <br><strong>NOTICE</strong><br>ANY HOLDER OF THIS CONSUMER CREDIT CONTRACT IS SUBJECT TO ALL CLAIMS AND DEFENSES WHICH THE DEBTOR COULD ASSERT AGAINST THE SELLER OF GOODS OR SERVICES OBTAINED WITH THE PROCEEDS HEREOF. RECOVERY HEREUNDER BY THE DEBTOR SHALL NOT EXCEED AMOUNTS PAID BY THE DEBTOR HEREUNDER.<br>\n\n          <br>By confirming the loan terms, I electronically accepted/signed the terms of this agreement.<br>\n      </div>\n      <div> <br> </div>\n\n      <table class=\"module\" role=\"module\" data-type=\"spacer\" border=\"1px\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: flexible;\">\n        <tbody>\n          <tr>\n            <td style=\"padding:10px 5px 15px 25px; line-height:28px; text-align:inherit; background-color:#b7b7b7;\" height=\"100%\" align=\"center\" colspan=\"2\" bgcolor=\"#f6f6f6\" role=\"module-content\"><div>\n              <div style=\"font-family: inherit; text-align: center\">\n                <p style=\"font-family: inherit; text-align: center\"><span style=\"line-height: 38x;font-size: 18px\"><strong>EXHIBIT A </strong></span>\n                </p>\n            </div>\n              <div style=\"font-family: inherit; text-align: center\"><span style=\"line-height: 38x;font-size: 30px\"><strong>Final Payment Schedule</strong></span></div></div>\n            </td>\n          </tr>\n          <tr>\n            <td style=\"padding:10px 5px 15px 25px; line-height:15px;\" role=\"module-content\" align=\"left\" colspan=\"2\" width=\"100%\" bgcolor=\"#f6f6f6\"><strong>Application Date: </strong>02/08/2022</td>\n          </tr>\n          <tr>\n            <th style=\"padding:10px 5px 5px 25px;\" role=\"module-content\" align=\"center\" colspan=\"2\" bgcolor=\"#b7b7b7\">Borrower Information</th>\n          </tr>\n\n          <tr>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Name:</strong> <br></br>Charles Yeager</td>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Address:</strong> <br></br>7200 Spurlock Dr. Austin TX 78731</td>\n          </tr>\n          <tr>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Email:</strong> <br></br>cdougy91@gmail.com</td>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Phone Number:</strong> <br></br>+1 8656046546</td>\n          </tr>\n\n        </tbody>\n        <tbody>\n          <tr>\n            <th style=\"padding:10px 5px 5px 25px;\" role=\"module-content\" align=\"center\" colspan=\"2\" bgcolor=\"#b7b7b7\">Know Technologies Inc.</th>\n          </tr>\n          <tr>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Address:</strong> <br></br>7200 Spurlock Dr </td>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>City & State:</strong> <br></br>Austin, Texas 78731</td>\n          </tr>\n          <tr>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Email:</strong> <br></br>support@goknow.me</td>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Phone Number:</strong> <br></br>+1 (512) 253-8896</td>\n          </tr>\n\n          </tr>\n        </tbody>\n        <tbody>\n          <tr>\n            <th style=\"padding:5px 5px 5px 5px;\" role=\"module-content\" align=\"center\" colspan=\"2\" bgcolor=\"#b7b7b7\">Bank Information</th>\n          </tr>\n          <tr>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Partner Bank:</strong> <br></br>TransPecos Banks</td>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Street Address:</strong> <br></br>112 E. Pecan Street, Suite 800</td>\n          </tr>\n          <tr>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>City & State:</strong> <br></br>San Antonio, Texas</td>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Postal Code:</strong> <br></br>78205</td>\n          </tr>\n\n          </tr>\n        </tbody>\n        <tbody>\n          <tr>\n            <th style=\"padding:5px 5px 5px 5px;\" role=\"module-content\" align=\"center\" colspan=\"2\" bgcolor=\"#b7b7b7\">Financial Product Information</th>\n          </tr>\n          <tr>\n            <th style=\"padding:10px 5px 5px 25px;\" role=\"module-content\" align=\"left\" colspan=\"2\" bgcolor=\"#f6f6f6\">Product Type: Buy Now, Pay Later</th>\n          </tr>\n          <tr>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Funding Date:</strong> <br></br>02/08/2022</td>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Total Amount Borrowed:</strong> <br></br>$1200.00</td>\n          </tr>\n          <tr>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Interest Rate (APR):</strong> <br></br>0.00</td>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Interest Type:</strong> <br></br>Fixed</td>\n          </tr>\n          <tr>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Financing Charges (if applicable):</strong> <br></br>0.00</td>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Other Fees:</strong> <br></br>$0.00</td>\n          </tr>\n          <tr>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Maturity Date:</strong> <br></br>03/24/2022</td>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Total Cost of Credit:</strong> <br></br>$1200.00</td>\n          </tr>\n          <tr>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Total Number of Payments:</strong> <br></br>4</td>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Payment Frequency:</strong> <br></br>bi-weekly</td>\n          </tr>\n          <tr>\n            <td style=\"padding:5px 5px 5px 5px; line-height:15px;\" role=\"module-content\" align=\"center\" colspan=\"2\" bgcolor=\"#b7b7b7\"><strong>Payment Schedule</strong></td>\n          </tr>\n          <tr>\n            <td style=\"padding:10px 5px 5px 0px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\">\n              <ul>\n                <li style=\"line-height:25px\">Down Payment: 02/08/2022</li>\n                <li style=\"line-height:25px\">Payment Due Date: 02/24/2022</li>\n                <li style=\"line-height:25px\">Payment Due Date: 03/10/2022</li>\n                <li style=\"line-height:25px\">Payment Due Date: 03/24/2022</li>\n              </ul>\n            </td>\n            <td style=\"padding:10px 5px 5px 0px; line-height:20px;\" role=\"module-content\" bgcolor=\"#f6f6f6\">\n              <ul>\n                <li style=\"line-height:25px\">$300.00</li>\n                <li style=\"line-height:25px\">Amount Due: $300.00</li>\n                <li style=\"line-height:25px\">Amount Due: $300.00</li>\n                <li style=\"line-height:25px\">Amount Due: $300.00</li>\n              </ul>\n            </td>\n\n\n          </tr>\n        </tbody>\n      </table>\n\n    </div>\n  </main>\n\n</body>\n</html>\n",
   "payment_2_date" : "03/10/2022",
   "payment_1_date" : "02/24/2022",
   "start_date" : "02/10/2022",
   "amount_remaining" : "900.00",
   "final_payment_amount" : "300.00",
   "number_of_payments_remaining" : 3
}
Attributes
amount string
The amount (in currency) that the loan is for. For example 1200.0.
down_payment string
The amount (in currency) that the consumer will have to pay up front. For example 100.0.
amount_remaining string
The amount (in currency) that the consumer has left to pay after the down payment. For example 100.00.
final_payment_amount string
The amount (in currency) that the consumer will have to pay on the last payment. For example 100.03.
product_details hash
The loan product details.
execution_date string
The date (MM/DD/YYYY) of the TIL execution.
payment_X_date string
The date (MM/DD/YYYY) of payment X due date (where X could be any of the pament numbers).
start_date string
The date (MM/DD/YYYY) of the start of the loan.
number_of_payments_remaining integer
Total number of payments remaining after the down payment.
html_content string
The HTML content of the raw TIL statement.

Create a til

POST /v1/tils

$ curl https://api.goknow.me/v1/tils -X POST \
  -H "Site-ID: 92e534a4-9de3-4072-944d-b09604d76498" \
  -d "payment[amount]=1200" \
  -d "payment[currency]=usd" \
  -d "payment[hold_until]=2022-02-10" \
  -d "email[address]=cdougy91@gmail.com" \
  -d "phone[number]=8656046546" \
  -d "phone[country_code]=1" \
  -d "bill[first_name]=Charles" \
  -d "bill[last_name]=Yeager" \
  -d "bill[address]=7200 Spurlock Dr." \
  -d "bill[city]=Austin" \
  -d "bill[state]=TX" \
  -d "bill[zip]=78731" \
  -d "bill[country]=USA" \
  -d "category=BNPL"

RESPONSE

{
   "payment_3_date" : "03/24/2022",
   "down_payment" : "300.00",
   "execution_date" : "02/08/2022",
   "product_details" : {
      "number_of_payments" : "4",
      "fee_down" : true,
      "interest_amount" : "0.00",
      "fee" : "0.00",
      "now_amount" : "300.00",
      "description" : "Pay 4",
      "frequency" : "bi-weekly",
      "past_due_days" : "6",
      "total_amount" : "1200.00",
      "category" : "BNPL",
      "id" : "1",
      "apr" : "0.00",
      "number_of_loan_payments" : "4",
      "til_url" : "https://www.goknow.me/legal/til?email[address]=cdougy91@gmail.com&payment[currency]=usd&payment[amount]=1200&payment[hold_until]=2022-02-10&site_id=92e534a4-9de3-4072-944d-b09604d76498&category=BNPL&phone[number]=8656046546&phone[country_code]=1&bill[country]=USA&bill[city]=Austin&bill[zip]=78731&bill[address]=7200%20Spurlock%20Dr.&bill[first_name]=Charles&bill[last_name]=Yeager&bill[state]=TX",
      "payment_amount" : "300.00"
   },
   "amount" : "1200.00",
   "maturity_date" : "03/24/2022",
   "html_content" : "<!DOCTYPE html><!--  This site was created in Webflow. http://www.webflow.com  -->\n<!--  Last Published: Thu Dec 02 2021 23:58:02 GMT+0000 (Coordinated Universal Time)  -->\n<html data-wf-page=\"61a94956b2ab647b6cf62ef6\" data-wf-site=\"614364de82ead317140bf4a5\">\n<head>\n  <meta charset=\"utf-8\">\n  <title>TIL</title>\n  <meta content=\"TIL\" property=\"og:title\">\n  <meta content=\"TIL\" property=\"twitter:title\">\n  <meta content=\"width=device-width, initial-scale=1\" name=\"viewport\">\n  <meta content=\"Webflow\" name=\"generator\">\n  <link href=\"css/normalize.css\" rel=\"stylesheet\" type=\"text/css\">\n  <link href=\"css/webflow.css\" rel=\"stylesheet\" type=\"text/css\">\n  <link href=\"css/goknow-me.webflow.css\" rel=\"stylesheet\" type=\"text/css\">\n  <!-- [if lt IE 9]><script src=\"https://cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv.min.js\" type=\"text/javascript\"></script><![endif] -->\n  <script type=\"text/javascript\">!function(o,c){var n=c.documentElement,t=\" w-mod-\";n.className+=t+\"js\",(\"ontouchstart\"in o||o.DocumentTouch&&c instanceof DocumentTouch)&&(n.className+=t+\"touch\")}(window,document);</script>\n  <link href=\"images/favicon.png\" rel=\"shortcut icon\" type=\"image/x-icon\">\n  <link href=\"images/webclip.png\" rel=\"apple-touch-icon\">\n  <script src=\"https://www.google.com/recaptcha/api.js\" type=\"text/javascript\"></script>\n  <style>\n::selection {background: #F2FE9A; color: #1C1D21; text-shadow: none;}\nbody .transition {display: block}\n.w-editor .transition {display: none;}\n.no-scroll-transition {overflow: hidden; position: relative;}\n</style>\n</head>\n<body class=\"body-9\">\n  <main id=\"main-content\" class=\"main-content wf-section\">\n    <div class=\"container-15 w-container\">\n      <div style=\"padding:10px 15px 15px 25px;\">\n        <h2>BNPL/Loan Agreement</h2>\n        <br><strong>1. Promise to Pay.</strong><br>In return for a loan that I have received from one of Know's Bank Partners as indicated on my loan schedule at the bottom of this agreement, I promise to pay U.S. amount plus any Finance Charge to the indicated Bank Partner on the loan schedule. The pronouns \"I\", \"me\" and \"my\" in this Agreement refer to the borrower to whom the loan is made. I understand that my loan and this Agreement may be assigned. Know's Bank Partner(s) or any person who my loan and this Agreement is transferred to is called \"the Loan Holder\" in this Agreement.<br>\n          <br><strong>2. Term.</strong><br>The scheduled term of my loan begins on the calendar day I executed this agreement and ends on the calendar day when the loan and any associated fees or penalties have been repaid in full. I understand that my repayment schedule can be found on the repayment schedule found at the bottom of this agreement. <br>\n\n          <br><strong>3. Interest.</strong><br>I will pay interest as presented on my loan offer and as indicated on my repayment schedule below. This is a simple interest loan, which means that interest accrues daily on the unpaid principal balance, up to the amount of the Finance Charge, until you pay the loan in full.<br>\n\n          <br><strong>4. Payments.</strong><br>My loan requires me to make minimum payments of principal and interest in an amount sufficient to pay off my principal loan balance and any accrued interest by the end of the loan term. I will pay my loan in the amount and on or by the dates indicated in my repayment schedule. My final monthly payment may be more or less than the regularly scheduled monthly payment. My first monthly payment is due, as indicated on my repayment schedule. I will be notified later of the exact date my first monthly payment is due. My remaining monthly payments will be due on the same numerical day of the remaining calendar months.\n\n          If I have agreed to using the Know Buy Now Pay Later service I promise to abide by the payment schedule where as my first payment of twenty-five percent (25%) of the total purchase price will be due upon my entering into this agreement. The remaining three (3) payments of equal payments will be made on the bi-weekly dates indicated on my repayment schedule.<br>\n\n          <br><strong>5. Payment Methods.</strong><br>I will make my payments, using one of the methods made available to me by the Loan Holder, currently debit card and ACH transfer are acceptable methods.<br>\n\n          <br><strong>6. Your Right to Prepay; Refund of Unearned Interest.</strong><br>I may prepay my loan in full at any time without penalty. I am entitled to a refund of any amounts I may pay to the Loan Holder in excess of the remaining principal balance and accrued interest as of the date of prepayment. The Loan Holder will compute the refund as provided in N.J. Stat. Ann. § 17:9A-56. Notwithstanding the foregoing, I agree that the Loan Holder may set off any amounts I am entitled to against any amounts I owe the Loan Holder on any other loan or otherwise.<br>\n\n          <br><strong>7. Failure to Pay as Required.</strong>\n          <br>a. Default. If I do not pay the full amount of each payment on the date it is due, I will be in default.<br>\n          <br>b. Notice of Default. If I am in default, the Loan Holder may send me a notice telling me that if I do not pay the overdue amount by a certain date, the Loan Holder may require me to pay immediately the full amount of my loan, less any unearned interest.<br>\n          <br>c. No Waiver by the Loan Holder. Even if, at a time when I am in default, the Loan Holder does not require me to pay immediately in full as provided in Section 7(b), the Loan Holder will still have the right to do so if I am in default at a later time.<br><br>d. Payment of the Loan Holder's Costs and Expenses. If the Loan Holder has required me to pay immediately in full as described above, the Loan Holder will have the right to be paid back by me for all of its costs and expenses in enforcing this Agreement to the extent not prohibited by applicable law. Those expenses include, for example, reasonable attorneys' fees.<br>\n\n          <br><strong>8. Notices.</strong><br>Unless applicable law requires a different method, any notice that must be given to me under this Agreement may be given, at the Loan Holder's option, electronically, by telephone, in writing by U.S. Mail or by providing it to me in any other manner, in each instance using the contact information the Loan Holder or its representative has on file for me.<br>\n\n          <br><strong>9. Waivers.</strong><br>I waive the rights of Presentment and Notice of Dishonor. \"Presentment\" means the right to require the Loan Holder to demand payment of amounts due. \"Notice of Dishonor\" means the right to require the Loan Holder to give notice to me that amounts due have not been paid.<br>\n\n          <br><strong>10. Loan Charges.</strong><br>If a law, which applies to my loan and which sets maximum loan charges, is finally interpreted so that the interest or other loan charges collected or to be collected in connection with my loan exceeded or exceeds the permitted limit, then: (a) any such loan charge will be reduced by the amount necessary to reduce the charge to the permitted limit; and (b) any sums already collected from me which exceeded permitted limits will be refunded to me, subject to the Loan Holder's right of set off provided in Section 6. The Loan Holder may choose to make this refund by reducing the amount I owe or by making a direct payment to me.<br>\n\n          <br><strong>11. When a Loan Is Made.</strong><br>The Bank who's name is listed on the repayment schedule of this agreement makes a loan to me and I receive a loan from said Bank when the Bank pays the merchant the loan proceeds on my behalf for my purchase of goods or services. After I am approved for a loan and agree to the terms of this Agreement, the Bank who's name appears on the repayment schedule in the agreement may decide not to make me a loan for any reason.<br>\n\n          <br><strong>12. Mandatory Arbitration.</strong><br>THIS SECTION AFFECTS THE BORROWER'S RIGHTS, PLEASE READ CAREFULLY BEFORE AGREEING TO THIS AGREEMENT'S TERMS. Except as otherwise explicitly provided in this Section, I, any Loan Holder, and/or Know Technologies, Inc. (\"Know\") can elect to resolve any dispute or claim relating in any way to my loan or this Agreement that cannot be resolved directly between me, Know, and/or any Loan Holder by binding arbitration under the Consumer Arbitration Rules (\"the Consumer Rules\") of the American Arbitration Association (\"AAA\"), rather than in court. Except as otherwise explicitly provided in this Section, this includes any claims based in contract, statute, tort, fraud, misrepresentation or any other legal theory. The Federal Arbitration Act and federal arbitration law apply to this Agreement. There is no judge or jury in arbitration and court review of an arbitration award is limited, but an arbitrator can award an individual the same damages and relief as a court and must apply and follow the terms of this Agreement as a court would. Any judgment on the award rendered by the arbitrator will be final and may be entered in any court of competent jurisdiction. I UNDERSTAND THAT ABSENT MY CONSENT TO ARBITRATION, I WOULD HAVE THE RIGHT TO SUE IN COURT AND HAVE A TRIAL BY JURY. Either Know, any Loan Holder or I can initiate arbitration through AAA, an alternative dispute resolution provider. Any arbitration will be governed by the then-current Consumer Rules of the AAA, and its Procedures for the Resolution of Disputes through Document Submission (\"Document Submission Procedures\"). The Consumer Rules are available at the AAA website: <a href=\"http://www.adr.org/\" target=\"_blank\">www.adr.org</a>. The Document Submission Procedures are included in the Consumer Rules. My arbitration filing fees will be governed by the Consumer Rules. If it is determined by the arbitrator that I cannot afford such fees, Know and/or the Loan Holder will pay all arbitration fees and expenses. The arbitration will be conducted solely based on written submissions. The arbitration will not involve any personal appearance by the parties or witnesses unless the arbitrator determines that a telephonic or in-person conference or hearing is necessary based on the request of one or more of the parties. The parties grant the arbitrator the exclusive power to rule on any challenges to the requirement for the use of the alternative dispute resolution process in this manner. Know, any Loan Holder and I each agree that any dispute resolution proceedings will be conducted only on an individual basis and not in a class, consolidated or representative action. To the fullest extent permitted by law: (a) no arbitration will be joined with any other; (b) there is no right or authority for any dispute to be arbitrated on a class-action basis or to utilize class action procedures; and (c) there is no right or authority for any dispute to be brought in a purported representative capacity on behalf of the general public or any other persons. If for any reason a claim proceeds in court rather than in arbitration, we each waive any right to a jury trial and agree to proceed only on an individual basis and not in a class, consolidated or representative action. All claims I bring against Know and/or the Loan Holder must be resolved in accordance with this Section. Any claim filed or brought contrary to this Section will be considered improperly filed. Should I file a claim contrary to this Section, Know, and/or any Loan Holder may seek recovery of their attorneys&#x27; fees and costs, provided that Know and/or the Loan Holder has first notified me of the improperly filed claim and I have failed to promptly withdraw the claim. Know, any Loan Holder and I agree that any disputes seeking to enforce or protect, or concerning the validity of intellectual property rights will not be subject to binding arbitration under this Section. In addition, pursuant to Consumer Rules, any party may proceed with their claims in small claims court if that option is available in the applicable jurisdiction and the amount in controversy falls within the small claims court's jurisdictional limits. If any portion of this Section on mandatory arbitration is deemed invalid or unenforceable, the entire arbitration section will be deemed null and void. No portion of this Section on mandatory arbitration may be amended, severed, or waived absent a written agreement signed by all parties.<br>\n\n          <br><strong>13. Other Terms.</strong><br>This Agreement is governed by the laws of the United States of America, Texas, and, only to the extent required by applicable law, the laws of the jurisdiction where I reside, and not the conflicts of law principles of any jurisdiction. No modification to this Agreement is effective unless made in writing and signed by the Loan Holder and me. If any provision of this Agreement is found to be invalid or unenforceable, all other provisions will be enforced and construed as if the invalid provisions were never a part of this Agreement.<br>\n\n          <br>See Know's Terms of Service and Privacy Policy for additional information.<br>\n\n          <br><strong>14. Covered Borrowers under the Military Lending Act.</strong><br>Federal law provides important protections to members of the Armed Forces and their dependents relating to extensions of consumer credit. In general, the cost of consumer credit to a member of the Armed Forces and his or her dependent may not exceed an annual percentage rate of 36 percent. This rate must include, as applicable to the credit transaction or account: The costs associated with credit insurance premiums; fees for ancillary products sold in connection with the credit transaction; any application fee charged (other than certain application fees for specified credit transactions or accounts); and any participation fee charged (other than certain participation fees for a credit card account).<br><br>Notwithstanding any other provision of this Agreement, Sections 9 and 12 shall not apply to a \"covered borrower\" under the Military Lending Act, as defined in 32 C.F.R. § 232.3(g). Furthermore, nothing in this Agreement shall be construed as applying to a covered borrower to the extent inconsistent with the Military Lending Act.<br><br>To obtain an oral statement regarding the Military Annual Percentage Rate and a description of the payment obligation, covered borrowers may call the following toll-free phone number: (855) 411-2372<br>\n\n          <br><strong>NOTICE</strong><br>ANY HOLDER OF THIS CONSUMER CREDIT CONTRACT IS SUBJECT TO ALL CLAIMS AND DEFENSES WHICH THE DEBTOR COULD ASSERT AGAINST THE SELLER OF GOODS OR SERVICES OBTAINED WITH THE PROCEEDS HEREOF. RECOVERY HEREUNDER BY THE DEBTOR SHALL NOT EXCEED AMOUNTS PAID BY THE DEBTOR HEREUNDER.<br>\n\n          <br>By confirming the loan terms, I electronically accepted/signed the terms of this agreement.<br>\n      </div>\n      <div> <br> </div>\n\n      <table class=\"module\" role=\"module\" data-type=\"spacer\" border=\"1px\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: flexible;\">\n        <tbody>\n          <tr>\n            <td style=\"padding:10px 5px 15px 25px; line-height:28px; text-align:inherit; background-color:#b7b7b7;\" height=\"100%\" align=\"center\" colspan=\"2\" bgcolor=\"#f6f6f6\" role=\"module-content\"><div>\n              <div style=\"font-family: inherit; text-align: center\">\n                <p style=\"font-family: inherit; text-align: center\"><span style=\"line-height: 38x;font-size: 18px\"><strong>EXHIBIT A </strong></span>\n                </p>\n            </div>\n              <div style=\"font-family: inherit; text-align: center\"><span style=\"line-height: 38x;font-size: 30px\"><strong>Final Payment Schedule</strong></span></div></div>\n            </td>\n          </tr>\n          <tr>\n            <td style=\"padding:10px 5px 15px 25px; line-height:15px;\" role=\"module-content\" align=\"left\" colspan=\"2\" width=\"100%\" bgcolor=\"#f6f6f6\"><strong>Application Date: </strong>02/08/2022</td>\n          </tr>\n          <tr>\n            <th style=\"padding:10px 5px 5px 25px;\" role=\"module-content\" align=\"center\" colspan=\"2\" bgcolor=\"#b7b7b7\">Borrower Information</th>\n          </tr>\n\n          <tr>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Name:</strong> <br></br>Charles Yeager</td>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Address:</strong> <br></br>7200 Spurlock Dr. Austin TX 78731</td>\n          </tr>\n          <tr>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Email:</strong> <br></br>cdougy91@gmail.com</td>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Phone Number:</strong> <br></br>+1 8656046546</td>\n          </tr>\n\n        </tbody>\n        <tbody>\n          <tr>\n            <th style=\"padding:10px 5px 5px 25px;\" role=\"module-content\" align=\"center\" colspan=\"2\" bgcolor=\"#b7b7b7\">Know Technologies Inc.</th>\n          </tr>\n          <tr>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Address:</strong> <br></br>7200 Spurlock Dr </td>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>City & State:</strong> <br></br>Austin, Texas 78731</td>\n          </tr>\n          <tr>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Email:</strong> <br></br>support@goknow.me</td>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Phone Number:</strong> <br></br>+1 (512) 253-8896</td>\n          </tr>\n\n          </tr>\n        </tbody>\n        <tbody>\n          <tr>\n            <th style=\"padding:5px 5px 5px 5px;\" role=\"module-content\" align=\"center\" colspan=\"2\" bgcolor=\"#b7b7b7\">Bank Information</th>\n          </tr>\n          <tr>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Partner Bank:</strong> <br></br>TransPecos Banks</td>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Street Address:</strong> <br></br>112 E. Pecan Street, Suite 800</td>\n          </tr>\n          <tr>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>City & State:</strong> <br></br>San Antonio, Texas</td>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Postal Code:</strong> <br></br>78205</td>\n          </tr>\n\n          </tr>\n        </tbody>\n        <tbody>\n          <tr>\n            <th style=\"padding:5px 5px 5px 5px;\" role=\"module-content\" align=\"center\" colspan=\"2\" bgcolor=\"#b7b7b7\">Financial Product Information</th>\n          </tr>\n          <tr>\n            <th style=\"padding:10px 5px 5px 25px;\" role=\"module-content\" align=\"left\" colspan=\"2\" bgcolor=\"#f6f6f6\">Product Type: Buy Now, Pay Later</th>\n          </tr>\n          <tr>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Funding Date:</strong> <br></br>02/08/2022</td>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Total Amount Borrowed:</strong> <br></br>$1200.00</td>\n          </tr>\n          <tr>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Interest Rate (APR):</strong> <br></br>0.00</td>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Interest Type:</strong> <br></br>Fixed</td>\n          </tr>\n          <tr>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Financing Charges (if applicable):</strong> <br></br>0.00</td>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Other Fees:</strong> <br></br>$0.00</td>\n          </tr>\n          <tr>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Maturity Date:</strong> <br></br>03/24/2022</td>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Total Cost of Credit:</strong> <br></br>$1200.00</td>\n          </tr>\n          <tr>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Total Number of Payments:</strong> <br></br>4</td>\n            <td style=\"padding:10px 5px 5px 25px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\"><strong>Payment Frequency:</strong> <br></br>bi-weekly</td>\n          </tr>\n          <tr>\n            <td style=\"padding:5px 5px 5px 5px; line-height:15px;\" role=\"module-content\" align=\"center\" colspan=\"2\" bgcolor=\"#b7b7b7\"><strong>Payment Schedule</strong></td>\n          </tr>\n          <tr>\n            <td style=\"padding:10px 5px 5px 0px; line-height:15px;\" role=\"module-content\" bgcolor=\"#f6f6f6\">\n              <ul>\n                <li style=\"line-height:25px\">Down Payment: 02/08/2022</li>\n                <li style=\"line-height:25px\">Payment Due Date: 02/24/2022</li>\n                <li style=\"line-height:25px\">Payment Due Date: 03/10/2022</li>\n                <li style=\"line-height:25px\">Payment Due Date: 03/24/2022</li>\n              </ul>\n            </td>\n            <td style=\"padding:10px 5px 5px 0px; line-height:20px;\" role=\"module-content\" bgcolor=\"#f6f6f6\">\n              <ul>\n                <li style=\"line-height:25px\">$300.00</li>\n                <li style=\"line-height:25px\">Amount Due: $300.00</li>\n                <li style=\"line-height:25px\">Amount Due: $300.00</li>\n                <li style=\"line-height:25px\">Amount Due: $300.00</li>\n              </ul>\n            </td>\n\n\n          </tr>\n        </tbody>\n      </table>\n\n    </div>\n  </main>\n\n</body>\n</html>\n",
   "payment_2_date" : "03/10/2022",
   "payment_1_date" : "02/24/2022",
   "start_date" : "02/10/2022",
   "amount_remaining" : "900.00",
   "final_payment_amount" : "300.00",
   "number_of_payments_remaining" : 3
}

To get a TIL content and details, you create a tils object.

Parameters
payment REQUIRED hash
The details of the amount that is being applied for.
phone REQUIRED hash
The details of the consumer phone number.
email REQUIRED hash
The details of the consumer email address.
bill REQUIRED hash
The details of the consumer address.
financials REQUIRED hash
The details of the consumer financial information.
category REQUIRED string - enum
The category of the loan product. Possible values are BNPL. Only BNPL categories are supported at present.
Returns
Returns the til object if the creation succeeded, or returns an error otherwise.

Loans

ENDPOINTS

  POST /v1/loans
   GET /v1/loans/:id
   GET /v1/loans
   GET /v1/loans/start/:start_index/limit/:limit
DELETE /v1/loans/:id
  POST /v1/loans/:id/authorize
  POST /v1/loans/:id/disburse
DELETE /v1/loans/:id/disburse
  POST /v1/loans
  POST /v1/loans/search
  POST /v1/loans/search/start/:start_index/limit/:limit
  POST /v1/loans/search/:start_timestamp/:end_timestamp
  POST /v1/loans/search/:start_timestamp/:end_timestamp/start/:start_index/limit/:limit

Manages the loan object. When a loan is created it is attached to the site and receiver that are defined in the site_id and receiver_id parameters when launching the know client. When the client closes, it returns a token loan_id that the site can use to disburse the loan.

A loan can be disbursed if it has been approved, but has not been disbursed, canceled, or paid. Each of these fields will either be null or contain a timestamp indicating when the action happened.

A loan can be canceled if it has been approved, but has not been paid.

Credits can be posted to the loan by the owner of the associated site_id. This could happen if the consumer returned an item or canceled a service. Loan details can be read by the owner of the associated site_id.

In order to create loans in the system for testing, it is possible to POST to the loan endpoint. Loans created with this endpoint will always be created for the amount of 0.00 in USD currency. When creating a loan for testing, the site_id parameter is required. Any site identifier can be used.

It is also possible to search for specific loans that match various parameters of the loan, including consumer details.

The loan object

THE LOAN OBJECT

{
   "disbursed" : "2021-02-18 19:48:14",
   "credits" : [ 
      {
         "payment" : {
            "source" : {
               "type" : "bank",
               "details" : {
                  "micro_deposits" : null,
                  "account" : "******0460",
                  "verified" : true,
                  "id" : "d10b90b3-b41a-49f6-972f-f49ff7628770",
                  "routing" : "314977405"
               }
            },
            "currency" : "usd",
            "amount" : "10.00",
            "fee_amount_included" : "0.00",
            "timestamp" : "2021-08-12 23:03:13",
            "status" : "completed",
            "completed" : "2021-08-12 23:03:13",
            "failed" : null,
            "returned" : false,
            "canceled" : null,
            "id" : "172a33a1-6c11-4c34-b938-c8131f854466"
         },
         "currency" : "usd",
         "paid" : "2021-08-12 23:03:13",
         "amount" : "10.00",
         "payor_id" : "669774a5-dbbc-481f-99ab-8c7c99d5d240",
         "posted" : "2021-08-12 23:03:13",
         "id" : "fa225106-8216-4fc5-aa5c-51bbf6b480ea",
         "meta" : {
            "my_name" : "my_value"
         },
         "canceled" : null
      }
   ],
   "site_id" : "92e534a4-9de3-4072-944d-b09604d76498",
   "meta" : {
      "fulfillment" : {
         "fulfillment" : "shopify",
         "order_status_url" : "https://elementalknowledge.myshopify.com/29133799502/orders/7d3a3fc58aacb0ad8660ddd964dd405f/authenticate?key=3f1981ac9181e59e4817aed8a41ce09a",
         "id" : "3905258946638"
      },
      "site" : {
         "name" : "Elemental Knowledge LLC",
         "dba" : null
      },
      "cart" : {
         "cost" : 1200,
         "sku" : "Leather Couch",
         "quantity" : 1,
         "shippable" : true,
         "description" : "Leather Couch",
         "image" : "//cdn.shopify.com/s/files/1/0291/3379/9502/products/Contemporary-Light-Brown-Leather-Sofa---Sidney-rcwilley-image1_800_small.jpg?v=1607531410",
         "tip" : 0,
         "currency" : "usd",
         "tax_rate" : 0,
         "amount" : 1200,
         "transaction_id" : null,
         "shipping" : 0,
         "tippable" : false
      }
   },
   "consumer_id" : "4f677b16-e308-4886-b56b-0cb0e33f05c4",
   "currency" : "usd",
   "id" : "2e5b273b-3013-4fb8-9acc-7279a1b40d76",
   "recipient_id" : "92e534a4-9de3-4072-944d-b09604d76498",
   "canceled" : null,
   "closed" : null,
   "payment" : {
      "source" : {
         "type" : "bank",
         "details" : {
            "micro_deposits" : null,
            "account" : "******0460",
            "verified" : true,
            "id" : "d10b90b3-b41a-49f6-972f-f49ff7628770",
            "routing" : "314977405"
         }
      },
      "currency" : "usd",
      "amount" : "1127.00",
      "fee_amount_included" : "0.00",
      "timestamp" : "2021-08-11 15:30:03",
      "status" : "failed",
      "completed" : "2021-08-12 23:03:13",
      "failed" : null,
      "returned" : false,
      "canceled" : null,
      "id" : "f00265f2-0019-4b8c-b7eb-b7f9520a065b"
   },
   "virtual_card" : {
      "number" : "6634547932732770",
      "exp_month" : 2,
      "cvc" : "876",
      "exp_year" : 2022
   },
   "authorized" : null,
   "payee_id" : null,
   "paid" : "2021-02-18 19:48:14",
   "til_agreed" : "2021-02-18 19:48:14",
   "amount" : "1200.00",
   "fee" : "72.00",
   "passthrough_payments" : [],
   "payments_from_site" : [],
   "processor_currently_valid" : true,
   "approved" : "2021-02-18 19:48:14"
}
Attributes
id string
Unique loan id (RFC-4122 UUID).
consumer_id string
Unique consumer id (RFC-4122 UUID).
fee string
The processing fee amount.
disbursed string
Formated timestamp (YYYY-MM-DD HH:MM:SS) determining when the loan has been set as disbursed. If null, disbursed has not been set.
paid string
Formated timestamp (YYYY-MM-DD HH:MM:SS) determining when the loan has been set as paid out to the site. If null, paid has not been set.
approved string
Formated timestamp (YYYY-MM-DD HH:MM:SS) determining when the loan has been approved to be disbursed. If null, approved has not been set.
authorized string
Formated timestamp (YYYY-MM-DD HH:MM:SS) determining when the loan has been authorized to be disbursed. If null, authorized has not been set.
canceled string
Formated timestamp (YYYY-MM-DD HH:MM:SS) determining when the loan has been set canceled. If null, canceled has not been set.
closed string
Formated timestamp (YYYY-MM-DD HH:MM:SS) determining when the loan has been set closed. If null, closed has not been set.
amount string
The amount (in currency) to process. A number, typically with a decimal. For example 9.56.
currency string
Currency abbreviation (lower case ISO 4217). For example the United States would be usd.
recipient_id string
Unique site id (RFC-4122 UUID) of the recipient site that the site_id has designated.
More attributes
credits array

passthrough_payments array

payments_from_site array

payment hash

meta hash

payee_id string

site_id string

processor_currently_valid enum

virtual_card hash

Create a loan

POST /v1/loans

$ curl https://api.goknow.me/v1/loans -X POST \
  -H "Site-ID: 92e534a4-9de3-4072-944d-b09604d76498" \
  -u 669774a5-dbbc-481f-99ab-8c7c99d5d240:0754cd6b-97f1-4138-b4bf-d78e2ccbf733

RESPONSE

{
   "disbursed" : null,
   "credits" : [],
   "site_id" : "92e534a4-9de3-4072-944d-b09604d76498",
   "meta" : null,
   "consumer_id" : "4f677b16-e308-4886-b56b-0cb0e33f05c4",
   "currency" : "usd",
   "id" : "532a8977-65bf-4b7c-ba51-c3d63bd63f5b",
   "recipient_id" : "92e534a4-9de3-4072-944d-b09604d76498",
   "canceled" : null,
   "closed" : null,
   "payment" : null,
   "payee_id" : null,
   "paid" : null,
   "amount" : "0.00",
   "til_agreed" : "2021-02-18 19:48:14",
   "virtual_card" : {
      "number" : "6634547932732770",
      "exp_month" : 2,
      "cvc" : "876",
      "exp_year" : 2022
   },
   "authorized" : null,
   "passthrough_payments" : [],
   "payments_from_site" : [],
   "approved" : "2021-02-18 21:04:59"
}

POST /v1/loans

$ curl https://api.goknow.me/v1/loans -X POST \
  -H "Site-ID: 92e534a4-9de3-4072-944d-b09604d76498" \
  -u 669774a5-dbbc-481f-99ab-8c7c99d5d240:0754cd6b-97f1-4138-b4bf-d78e2ccbf733
  -d "identity[ssn]=999-99-9999" \
  -d "identity[dob]=08-30-1972" \
  -d "payment[amount]=200.00" \
  -d "payment[currency]=usd" \
  -d "email[address]=cdougy91@gmail.com" \
  -d "bill[first_name]=Chuck" \
  -d "bill[last_name]=Yeager" \
  -d "bill[zip]=78731" \
  -d "bill[address]=7200 Spurlock Dr." \
  -d "cart[description]=invoice" \
  -d "financials[monthly_income]=1" \
  -d "card[number]=4242424242424242" \
  -d "card[exp_month]=6" \
  -d "card[exp_year]=2024" \
  -d "card[zip]=78731" \
  -d "card[cvc]=574" \
  -d "til_agreed=true" \
  -d "category=BNPL"

RESPONSE

{
   "disbursed" : null,
   "credits" : [],
   "fee" : null,
   "site_id" : "92e534a4-9de3-4072-944d-b09604d76498",
   "meta" : {
      "fulfillment" : {
         "fulfillment" : "shopify",
         "order_status_url" : "https://elementalknowledge.myshopify.com/29133799502/orders/0130eacf91e3e641f4b4429602b271a0/authenticate?key=90dd3f0694093451cccdfda520fd4806",
         "id" : "4214164619342"
      },
      "site" : {
         "name" : "Elemental Knowledge LLC",
         "dba" : null
      },
      "cart" : {
         "description" : "invoice"
      }
   },
   "consumer_id" : "4f677b16-e308-4886-b56b-0cb0e33f05c4",
   "currency" : "usd",
   "virtual_card" : {
      "number" : "6643370740029878",
      "exp_month" : 2,
      "cvc" : "624",
      "exp_year" : 2022
   },
   "id" : "857d4ff1-45a6-442e-92c0-1dba535063a7",
   "recipient_id" : "92e534a4-9de3-4072-944d-b09604d76498",
   "canceled" : null,
   "authorized" : null,
   "closed" : null,
   "payment" : null,
   "payee_id" : null,
   "paid" : null,
   "amount" : "200.00",
   "approved" : "2022-02-08 23:09:16",
   "passthrough_payments" : [],
   "payments_from_site" : [],
   "processor_currently_valid" : true,
   "til_agreed" : "2022-02-08 23:09:16"
}
Attributes
recipient_id string
Unique site id (RFC-4122 UUID) of the recipient site that the site_id has designated.
processor_access_id string
Unique processor access id (RFC-4122 UUID) of the processor to use to process both down payment and potential future payments with. If omitted, the default processor will be used.
til_agreed REQUIRED boolean
A true/false boolean taht indicates that the consumer has agreed to the terms and conditions of applying for an application witch includes that the consuemr has been made aware that their credit report will be pulled and that their credit will not be affected the the credit inquiry.
identity REQUIRED hash
Consumer identity details.
payment REQUIRED hash
The details of the amount that is being applied for.
phone REQUIRED hash
The details of the consumer phone number.
email REQUIRED hash
The details of the consumer email address.
bill REQUIRED hash
The details of the consumer address.
card REQUIRED hash
The details of the consumer payment card.
financials REQUIRED hash
The details of the consumer financial information.
category string - enum
The category of the loan product. Possible values are BNPL. Only BNPL categories are supported at present. option_id or category are required, but not both.
option_id string - string
The option id of the loan product that was returned in the previous application response for the consumer. option_id or category are required, but not both.
More attributes
fulfillment_access_id string

disburse boolean

cart hash

To create a loan for testing only, post NO parameters. All test loans will be created with a 0.00 amount. You need only supply the unique site identifier header Site-ID.

Returns
Returns the loan object if the creation succeeded, or returns an error otherwise.

Retrieve a loan

GET /v1/loans/:id

$ curl https://api.goknow.me/v1/loans/f3b883e3-fc06-4e6e-8892-f2dea537cbb1 -X GET \
  -u 669774a5-dbbc-481f-99ab-8c7c99d5d240:0754cd6b-97f1-4138-b4bf-d78e2ccbf733

RESPONSE

{
   "disbursed" : "2021-02-18 19:48:14",
   "credits" : [ 
      {
         "payment" : {
            "source" : {
               "type" : "bank",
               "details" : {
                  "micro_deposits" : null,
                  "account" : "******0460",
                  "verified" : true,
                  "id" : "d10b90b3-b41a-49f6-972f-f49ff7628770",
                  "routing" : "314977405"
               }
            },
            "currency" : "usd",
            "amount" : "10.00",
            "fee_amount_included" : "0.00",
            "timestamp" : "2021-08-12 23:03:13",
            "status" : "completed",
            "completed" : "2021-08-12 23:03:13",
            "failed" : null,
            "returned" : false,
            "canceled" : null,
            "id" : "172a33a1-6c11-4c34-b938-c8131f854466"
         },
         "currency" : "usd",
         "paid" : "2021-08-12 23:03:13",
         "amount" : "10.00",
         "payor_id" : "669774a5-dbbc-481f-99ab-8c7c99d5d240",
         "posted" : "2021-08-12 23:03:13",
         "id" : "fa225106-8216-4fc5-aa5c-51bbf6b480ea",
         "meta" : {
            "my_name" : "my_value"
         },
         "canceled" : null
      }
   ],
   "site_id" : "92e534a4-9de3-4072-944d-b09604d76498",
   "meta" : {
      "fulfillment" : {
         "fulfillment" : "shopify",
         "order_status_url" : "https://elementalknowledge.myshopify.com/29133799502/orders/7d3a3fc58aacb0ad8660ddd964dd405f/authenticate?key=3f1981ac9181e59e4817aed8a41ce09a",
         "id" : "3905258946638"
      },
      "site" : {
         "name" : "Elemental Knowledge LLC",
         "dba" : null
      },
      "cart" : {
         "cost" : 1200,
         "sku" : "Leather Couch",
         "quantity" : 1,
         "shippable" : true,
         "description" : "Leather Couch",
         "image" : "//cdn.shopify.com/s/files/1/0291/3379/9502/products/Contemporary-Light-Brown-Leather-Sofa---Sidney-rcwilley-image1_800_small.jpg?v=1607531410",
         "tip" : 0,
         "currency" : "usd",
         "tax_rate" : 0,
         "amount" : 1200,
         "transaction_id" : null,
         "shipping" : 0,
         "tippable" : false
      }
   },
   "consumer_id" : "4f677b16-e308-4886-b56b-0cb0e33f05c4",
   "currency" : "usd",
   "id" : "2e5b273b-3013-4fb8-9acc-7279a1b40d76",
   "recipient_id" : "92e534a4-9de3-4072-944d-b09604d76498",
   "canceled" : null,
   "closed" : null,
   "payment" : {
      "source" : {
         "type" : "bank",
         "details" : {
            "micro_deposits" : null,
            "account" : "******0460",
            "verified" : true,
            "id" : "d10b90b3-b41a-49f6-972f-f49ff7628770",
            "routing" : "314977405"
         }
      },
      "currency" : "usd",
      "amount" : "1127.00",
      "fee_amount_included" : "0.00",
      "timestamp" : "2021-08-11 15:30:03",
      "status" : "failed",
      "completed" : "2021-08-12 23:03:13",
      "failed" : null,
      "returned" : false,
      "canceled" : null,
      "id" : "f00265f2-0019-4b8c-b7eb-b7f9520a065b"
   },
   "virtual_card" : {
      "number" : "6634547932732770",
      "exp_month" : 2,
      "cvc" : "876",
      "exp_year" : 2022
   },
   "authorized" : null,
   "payee_id" : null,
   "paid" : "2021-02-18 19:48:14",
   "til_agreed" : "2021-02-18 19:48:14",
   "amount" : "1200.00",
   "fee" : "72.00",
   "passthrough_payments" : [],
   "payments_from_site" : [],
   "processor_currently_valid" : true,
   "approved" : "2021-02-18 19:48:14"
}

Retrieves the details of an existing loan. You need only supply the unique loan identifier that was returned upon customer creation.

Parameters
No parameters.
Returns
Returns the loan object, or returns an error otherwise.

Retrieve loans

GET /v1/loans

$ curl https://api.goknow.me/v1/loans -X GET \
  -H "Site-ID: 92e534a4-9de3-4072-944d-b09604d76498" \
  -u 669774a5-dbbc-481f-99ab-8c7c99d5d240:0754cd6b-97f1-4138-b4bf-d78e2ccbf733

GET /v1/loans/start/:start_index/limit/:limit

$ curl https://api.goknow.me/v1/loans/start/0/limit/3 -X GET \
  -H "Site-ID: 92e534a4-9de3-4072-944d-b09604d76498" \
  -u 669774a5-dbbc-481f-99ab-8c7c99d5d240:0754cd6b-97f1-4138-b4bf-d78e2ccbf733

RESPONSE

[
   {
      "disbursed" : "2021-02-18 19:48:14",
      "credits" : [ 
         {
            "payment" : {
               "source" : {
                  "type" : "bank",
                  "details" : {
                     "micro_deposits" : null,
                     "account" : "******0460",
                     "verified" : true,
                     "id" : "d10b90b3-b41a-49f6-972f-f49ff7628770",
                     "routing" : "314977405"
                  }
               },
               "currency" : "usd",
               "amount" : "10.00",
               "fee_amount_included" : "0.00",
               "timestamp" : "2021-08-12 23:03:13",
               "status" : "completed",
               "completed" : "2021-08-12 23:03:13",
               "failed" : null,
               "returned" : false,
               "canceled" : null,
               "id" : "172a33a1-6c11-4c34-b938-c8131f854466"
            },
            "currency" : "usd",
            "paid" : "2021-08-12 23:03:13",
            "amount" : "10.00",
            "payor_id" : "669774a5-dbbc-481f-99ab-8c7c99d5d240",
            "posted" : "2021-08-12 23:03:13",
            "id" : "fa225106-8216-4fc5-aa5c-51bbf6b480ea",
            "meta" : {
               "my_name" : "my_value"
            },
            "canceled" : null
         }
      ],
      "site_id" : "92e534a4-9de3-4072-944d-b09604d76498",
      "meta" : {
         "fulfillment" : {
            "fulfillment" : "shopify",
            "order_status_url" : "https://elementalknowledge.myshopify.com/29133799502/orders/7d3a3fc58aacb0ad8660ddd964dd405f/authenticate?key=3f1981ac9181e59e4817aed8a41ce09a",
            "id" : "3905258946638"
         },
         "site" : {
            "name" : "Elemental Knowledge LLC",
            "dba" : null
         },
         "cart" : {
            "cost" : 1200,
            "sku" : "Leather Couch",
            "quantity" : 1,
            "shippable" : true,
            "description" : "Leather Couch",
            "image" : "//cdn.shopify.com/s/files/1/0291/3379/9502/products/Contemporary-Light-Brown-Leather-Sofa---Sidney-rcwilley-image1_800_small.jpg?v=1607531410",
            "tip" : 0,
            "currency" : "usd",
            "tax_rate" : 0,
            "amount" : 1200,
            "transaction_id" : null,
            "shipping" : 0,
            "tippable" : false
         }
      },
      "consumer_id" : "4f677b16-e308-4886-b56b-0cb0e33f05c4",
      "currency" : "usd",
      "id" : "2e5b273b-3013-4fb8-9acc-7279a1b40d76",
      "recipient_id" : "92e534a4-9de3-4072-944d-b09604d76498",
      "canceled" : null,
      "closed" : null,
      "payment" : {
         "source" : {
            "type" : "bank",
            "details" : {
               "micro_deposits" : null,
               "account" : "******0460",
               "verified" : true,
               "id" : "d10b90b3-b41a-49f6-972f-f49ff7628770",
               "routing" : "314977405"
            }
         },
         "currency" : "usd",
         "amount" : "1127.00",
         "fee_amount_included" : "0.00",
         "timestamp" : "2021-08-11 15:30:03",
         "status" : "failed",
         "completed" : "2021-08-12 23:03:13",
         "failed" : null,
         "returned" : false,
         "canceled" : null,
         "id" : "f00265f2-0019-4b8c-b7eb-b7f9520a065b"
      },
      "virtual_card" : {
         "number" : "6634547932732770",
         "exp_month" : 2,
         "cvc" : "876"