Coverage

Check offers

POST
Check a set of offers against our limits for a given state. Customers can pass us a list of offers, which we will run through our compliance limits. We will return a boolean for each offer indicating whether the offer passes our limits or not.

Request

This endpoint expects an object.
state
stringRequired
The state the borrower is in (2 chars)
offers
list of objectsRequired
A list of CheckOffer objects, each uniquely identified by an id.

Response

This endpoint returns a map from strings to objects
is_compliant
boolean
Boolean indicating whether the offer passes our limits.
apr
integerOptional
The annual percentage rate for the offer. Null if not compliant or not applicable.

Errors

POST
1curl -X POST https://production.pier-finance.com/api/coverage/check_offers \
2 -H "Authorization: Bearer <token>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "state": "AK",
6 "offers": [
7 {
8 "id": "26",
9 "type": "loan_offer",
10 "amount": 300000,
11 "interest_rate": 750,
12 "origination_fee": 150,
13 "term": 24,
14 "first_payment_date": "2024-04-15",
15 "payment_period": "monthly"
16 },
17 {
18 "id": "27",
19 "type": "revolving_line_of_credit_offer",
20 "amount": 100000,
21 "interest_rate": 200,
22 "origination_fee": 0
23 }
24 ]
25}'
1{
2 "26": {
3 "is_compliant": true,
4 "apr": 955
5 },
6 "27": {
7 "is_compliant": true,
8 "apr": 200
9 }
10}