Read Lender Product Catalogue | Credit Platform | Documentation

{
  "products": [
    {
      "key": "personalLoan",
      "type": "PERSONAL_LOAN",
      "name": "Personal Loan",
      "available": true,
      "lenders": [
        {
          "id": "alpha",
          "name": "Alpha Finance",
          "available": true,
          "highlights": [
            "Fast eligibility check"
          ],
          "informationNeeded": {
            "required": [
              {
                "key": "contactNumber",
                "label": "Mobile number",
                "type": "phone",
                "sendIn": "profile.contactNumber",
                "sensitive": true
              },
              {
                "key": "creditReportConsent",
                "label": "Credit report consent",
                "type": "boolean",
                "sendIn": "journey.creditReportConsent",
                "sensitive": false
              }
            ],
            "optional": [],
            "conditional": []
          }
        }
      ]
    },
    {
      "key": "goldLoan",
      "type": "GOLD_LOAN",
      "name": "Gold Loan",
      "available": false,
      "lenders": [],
      "unavailableReason": "No lenders are currently available for this product."
    }
  ]
}

Backend-only API-key call. Returns the product and lender catalogue for the authenticated API key scope. Use this to decide which products to show, which lenders are available under each product, and what borrower information to collect before creating a Hosted Experience URL or starting a Hybrid Experience journey.

Authentication

AuthorizationBearer

Send Authorization: Bearer <PLATFORM_API_KEY> from a trusted back-end.

Response

Returns the lender product catalogue for the authenticated API key scope.

productslist of objects

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error

1	{
2	"products": [
3	{
4	"key": "personalLoan",
5	"type": "PERSONAL_LOAN",
6	"name": "Personal Loan",
7	"available": true,
8	"lenders": [
9	{
10	"id": "alpha",
11	"name": "Alpha Finance",
12	"available": true,
13	"highlights": [
14	"Fast eligibility check"
15	],
16	"informationNeeded": {
17	"required": [
18	{
19	"key": "contactNumber",
20	"label": "Mobile number",
21	"type": "phone",
22	"sendIn": "profile.contactNumber",
23	"sensitive": true
24	},
25	{
26	"key": "creditReportConsent",
27	"label": "Credit report consent",
28	"type": "boolean",
29	"sendIn": "journey.creditReportConsent",
30	"sensitive": false
31	}
32	],
33	"optional": [],
34	"conditional": []
35	}
36	}
37	]
38	},
39	{
40	"key": "goldLoan",
41	"type": "GOLD_LOAN",
42	"name": "Gold Loan",
43	"available": false,
44	"lenders": [],
45	"unavailableReason": "No lenders are currently available for this product."
46	}
47	]
48	}

$	curl https://credit.aarthiklabs.com/api/lab/features \
>	-H "Authorization: Bearer <token>"