Get Forms

The Get Forms API allows you to retrieve a list of available forms in the system filtered by form type. This is typically used as a first step in the form submission workflow to identify which form templates are available for a customer to complete.

API Endpoint

GET {base_url}/ExtForm/forms

Request Format

This endpoint accepts a GET request with query parameters for filtering.

Request Headers

Authorization: Bearer {token}

Response Format

{
  "statusCode": 200,
  "messages": ["Processed successfully"],
  "result": {
    "count": 2,
    "forms": [
      {
        "formId": "7ac9ab5e-4123-4456-b8c3-123456789012",
        "formName": "Individual KYC Form"
      },
      {
        "formId": "8bd0bc6f-5234-5567-c9d4-234567890123",
        "formName": "Corporate KYC Form"
      }
    ]
  }
}

Response Fields

Field	Description
count	Total number of forms returned
forms	Array of form objects
forms[].formId	Unique identifier for the form
forms[].formName	Display name of the form

Example Usage

cURL Example

curl -X GET \
  '{base_url}/ExtForm/forms' \
  -H 'Authorization: Bearer your_token_here'

Error Handling

Status Code	Description	Solution
400	Invalid request parameters
401	Unauthorized	Verify your authentication token
403	Forbidden	Check that your account has permission to access forms
500	Internal server error	Contact support with the error details

Related Resources

• Get Form Fields API - Retrieving detailed form structure and fields
• Save Submission API - Submitting form answers