Get Application Metadata

The Get Application Metadata endpoint retrieves all financial products available to the client. Each product includes a unique ID, a name, and a description.

This endpoint is typically the first call in the credit application flow. Use it to retrieve the available products and populate product selection options in your user interface before submitting an application. The id returned for a product is the value you pass as the productId field when creating a credit application.

Prerequisites

To integrate calls to the Get Application Metadata endpoint, you need:

• Your own user interface, such as a mobile app or web page, to display available credit products to a user and allow them to select one before beginning an application.

Example Request

Retrieve available financial products by making a GET request to the Get Application Metadata endpoint.

GET {{baseUrl}}/api/v1/credit/applications/metadata

Example Response

A successful request returns a 200 HTTP code and the response includes an available_financial_products array. Each item in the array represents a financial product available to the client.

{
  "available_financial_products": [
    {
      "id": "prod_123456",
      "name": "Standard Credit Card",
      "description": "A standard revolving line of credit with competitive rates."
    },
    {
      "id": "prod_789012",
      "name": "Premium Credit Card",
      "description": "A premium revolving line of credit with enhanced benefits."
    }
  ]
}

Response Fields

Each object in the available_financial_products array contains the following fields: