Explore a full, working code sample of a loan integration with our Application Programming Interface (API). This documentation will outline the basic steps of fetching a list of additional questions or inspection questions from the policyPay system.
You can see all the available REST methods via our Swagger at rest.policypay.io or uat-rest.policypay.io
User Credentials
Email: ***
Password: ***
Public Key: ***
Secret Key: ***
Swagger API Endpoint Definitions
Once logged in with your given credentials, navigate to /collections /collection/additional_questions/{id} or /collection/additional_questions/{id}.
Selecting Try it out will bring up the request body for your API endpoint definitions. Once filled in completely, selecting Execute will run the API.
A response payload will be returned which includes your API endpoints along with a successul 200 code displayed. See Response Codes below for further details.
To fetch collection questions, use an id input.
| Variable | Type | Required | Notes |
|---|---|---|---|
| id (path) | String | Yes |
Postman API Link
An alternate way of using our API is with your given Postman link. The link will take you to your already configured endpoint for you to fill out. In the Body section on Postman, you will find your configured endpoints. Once filled, selecting Send will execute the API call.
Congratulations! You have successfully retrieved your collection questions.
Sample JSON Response
{
"status": "success",
"message": "string",
"questions": [
{
"text": "string",
"key": "string",
"type": "string",
"options": "string",
"answer": "string"
}
]
}
Response Codes
| Code | Description |
|---|---|
| 200 | Collection questions retrieved successfully |
| 400 | Failed to fetch questions |
| 422 | Unprocessable entry |
| 500 | Internal server error |
