Skip to main content

Forms & Submissions

The Forms & Submissions APIs allow external systems to programmatically complete and submit forms through azakaw's platform. This is particularly useful for automating customer onboarding, KYC processes, and other form-based workflows.

Overview​

The Forms & Submissions integration typically follows this workflow:

  1. Retrieve Available Forms - Use the Get Forms API to retrieve the available form templates filtered by form type (e.g., KYCOnboarding, Questionnaire).

  2. Get Form Structure - Use the Get Form Fields API to understand the structure, fields, and field types of a specific form.

  3. Document Upload - If your form answers require supporting documents (e.g., identity documents, tax forms, proof of address), you'll need to upload these documents using the Documents Upload API.

  4. Form Submission - After obtaining document IDs (if needed), you can submit form answers using the Save Submission API.

  5. Track Submissions - Monitor the status of submissions using the Get Submissions API.

  6. Manage Documents - Retrieve, download, or delete documents associated with submissions as needed.

Each form field requires a specific answer model that corresponds to the field type. For example, a passport upload field requires a PassportAnswerRequestModel, while a country selection field requires a CountryAnswerRequestModel.

Key Concepts​

RESTful Endpoints​

Our API follows RESTful principles with resource-oriented URLs:

  • Forms resources: /ExtForm/forms
  • Submissions resources: /ExtForm/submissions
  • Documents within submissions: /ExtForm/submissions/{submissionId}/documents
  • Lookup data: /ExtForm/lookups

Field Identification​

When submitting answers, each field can be identified in two ways:

  1. Field ID - Using the unique identifier (fieldId) returned by the Get Form Fields API.

  2. Field ID - Using the unique field identifier provided by the form structure

  3. Field Qualification Name (FQN) - Using the fully qualified name, which follows the pattern (for reference only):

{PageName}_{SectionName}_{FieldName}

For example: PersonalInfo_Identity_Passport

You must provide the fieldId for each answer in your submission.

Answer Models​

Answer models define the structure of data required for each field type. All answer models inherit from the base AnswerItemRequestModel class and include additional properties specific to their field type.

Document IDs​

When documents are uploaded via the Documents Upload API, each document is assigned a unique ID. These IDs are then referenced in the appropriate answer models when submitting the form.

Common Use Cases​

  • Automated Onboarding - Integrate with your CRM system to automatically populate and submit customer information.
  • Document Processing - Upload and associate required documents with specific form fields.
  • Bulk Processing - Process multiple customers by programmatically submitting forms for each.
  • Workflow Integration - Incorporate form submission into your existing business processes.
  • Submission Tracking - Monitor the progress of submissions through their lifecycle.

Next Steps​

Refer to the following documentation to implement the Forms & Submissions APIs: