Check offers

POST

/coverage/check_offers

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. If the user does not specify an ID for each offer, we will reindex them from 0.

Request

This endpoint expects an object.

statestringRequired

The state the borrower is in (2 chars)

offerslist of objectsRequired

A list of CheckOffer objects, each uniquely identified by an id.

Response

This endpoint returns a map from strings to objects.

is_compliantboolean

Boolean indicating whether the offer passes our limits.

aprintegerOptional

The annual percentage rate for the offer. Null if not compliant or not applicable.

Errors

POST

1 curl -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       "type": "loan_offer",
9       "amount": 300000,
10       "interest_rate": 750,
11       "loan_term": {
12         "term_type": "months",
13         "term": 12
14       },
15       "origination_fee": 150,
16       "id": 26,
17       "first_payment_date": "2024-04-15",
18       "payment_period": "monthly"
19     },
20     {
21       "type": "revolving_line_of_credit_offer",
22       "amount": 100000,
23       "interest_rate": 200,
24       "loan_term": {
25         "term_type": "months",
26         "term": 12
27       },
28       "origination_fee": 0,
29       "id": 27
30     }
31   ]
32 }'

200Successful

1 {
2   "26": {
3     "is_compliant": true,
4     "apr": 955
5   },
6   "27": {
7     "is_compliant": true,
8     "apr": 200
9   }
10 }

Built with

1	curl -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	"type": "loan_offer",
9	"amount": 300000,
10	"interest_rate": 750,
11	"loan_term": {
12	"term_type": "months",
13	"term": 12
14	},
15	"origination_fee": 150,
16	"id": 26,
17	"first_payment_date": "2024-04-15",
18	"payment_period": "monthly"
19	},
20	{
21	"type": "revolving_line_of_credit_offer",
22	"amount": 100000,
23	"interest_rate": 200,
24	"loan_term": {
25	"term_type": "months",
26	"term": 12
27	},
28	"origination_fee": 0,
29	"id": 27
30	}
31	]
32	}'

1	{
2	"26": {
3	"is_compliant": true,
4	"apr": 955
5	},
6	"27": {
7	"is_compliant": true,
8	"apr": 200
9	}
10	}