Skip to main content

External Application Integration

This page explains how organizations can configure Axvero to view and manage applications that are submitted from external systems (i.e., applications not created directly within Axvero).

Overview​

  • Axvero supports integration with external systems that submit applications to the organization's backend.
  • Once configured, these externally submitted applications are visible and manageable within Axvero, alongside native applications.

Configuration Steps​

1. Enable External Application Integration​

  • Go to the Organization Configuration section in Axvero admin.
  • Select "External Application Integration" from the settings menu.

2. Define Integration Method​

  • Choose how external applications will be submitted:
    • API endpoint: External system posts application data to a secure Axvero API.
    • File import: Upload application data in supported formats (e.g., JSON, CSV).
    • Third-party connectors: Use pre-built integrations for popular platforms.

3. Map Application Data​

  • Configure mapping between external application fields and Axvero's internal data model.
  • Ensure all required fields (e.g., applicant info, documents, status) are mapped correctly.

How Mapping Works​

Mapping is the process of connecting fields from the external application's data format (such as JSON or CSV) to Axvero's internal data model. This ensures that all relevant information is correctly imported and displayed in Axvero.

Example Mapping (JSON)​

Suppose an external system submits an application in the following JSON format:

{
  "externalApplicantName": "John Doe",
  "externalApplicantEmail": "john.doe@email.com",
  "externalStatus": "submitted",
  "externalDocuments": [
    { "docType": "passport", "fileUrl": "https://example.com/passport.pdf" }
  ]
}

You can map these fields to Axvero's internal model as follows:

External FieldAxvero Field
externalApplicantNameapplicantName
externalApplicantEmailapplicantEmail
externalStatusstatus
externalDocumentsdocuments

This mapping can be configured in the admin interface or via a mapping configuration file (YAML/JSON), depending on your integration method.

Example Mapping via Configuration File​
{
  "fieldMappings": {
    "externalApplicantName": "applicantName",
    "externalApplicantEmail": "applicantEmail",
    "externalStatus": "status",
    "externalDocuments": [
      {
        "docType": "documentType",
        "fileUrl": "fileUrl",
        "issuedDate": "issuedDate",
        "metadata": {
          "source": "sourceSystem",
          "verified": "isVerified"
        }
      }
    ]
  }
}

This allows you to map nested fields and arrays, supporting complex document structures. You can extend this approach for any level of nesting required by your external data format.

Example: Internal vs. External Application Structure​
{
  "applicantName": "John Doe",
  "applicantEmail": "john.doe@email.com",
  "status": "submitted",
  "documents": [
    {
      "documentType": "passport",
      "fileUrl": "https://axvero.com/files/passport.pdf",
      "issuedDate": "2025-01-01",
      "metadata": {
        "sourceSystem": "axvero",
        "isVerified": true
      }
    }
  ]
}

This mapping ensures that data from the external application is correctly transformed to match Axvero's internal structure, allowing seamless integration and management.

Advanced Array/Object Mapping​

Note: In the mapping configuration, you must explicitly specify how arrays and nested objects are mapped. For example, mapping externalDocuments (an array in the external data) to documents (an array in Axvero) requires a clear structure. You can also merge multiple external arrays into one internal array, or split one external array into multiple internal arrays.

Example: Merging Two External Arrays into One Internal Array​

Suppose you have two arrays in the external data:

{
  "externalDocuments": [],
  "externalAttachments": []
}
Example: Splitting One External Array into Multiple Internal Arrays​

Suppose you have one external array with mixed types:

{
  "externalFiles": [
    { "type": "document", "docType": "passport", "fileUrl": "..." },
    { "type": "attachment", "attachmentType": "invoice", "fileUrl": "..." }
  ]
}
Example: Explicit Array Mapping for Nested Structures​

To map externalDocuments to documents with nested fields:

arrayMappings:
  documents:
    - source: externalDocuments
      itemMapping:
        docType: documentType
        fileUrl: fileUrl
        issuedDate: issuedDate
        metadata:
          source: sourceSystem
          verified: isVerified
fieldMappings:
  # ...other field mappings...

These examples show how to handle advanced mapping scenarios. You can extend this approach for any level of complexity required by your external and internal data models.

Best Practice: Always document your array/object mappings and test with sample data to ensure correct transformation.

4. Set Permissions & Visibility​

  • Define which team members can view and manage external applications.
  • Set up notifications and workflow rules for externally submitted applications.

5. Test & Monitor Integration​

  • Submit test applications from the external system to verify integration.
  • Monitor logs and dashboards for successful imports and errors.

Best Practices​

  • Use secure authentication (API keys, OAuth) for all integrations.
  • Regularly review field mappings and update as needed.
  • Ensure compliance with data protection regulations.
  • Document all integration endpoints and processes for audit purposes.

For more details on API integration, see the developer documentation or contact Axvero support.