Skip to main content

Lookup API

Validate fields against external APIs for real-time data verification.

Settings​

  • HTTP connector - Required connector configuration
  • Endpoint URL - API endpoint to validate against
  • Context - Additional fields to include in API requests
  • Autocomplete - Enable suggestions with autocomplete URL
  • Translation - Enable value mapping with translation URL

Validation​

  • Sends field values to external API for validation
  • 2xx responses indicate successful validation
  • 30-second timeout for API responses
  • Supports batch requests for multiple fields

API Schema​

Request Body​

Your API endpoint receives an array of field objects:

[
  {
    "id": "string",
    "description": "string | null",
    "meta": {
      "[key: string]": "string | number | boolean | null"
    },
    "accuracy": "number",
    "content": "string | null",
    "creator_id": "string",
    "end_offset": "number",
    "entity_id": "e5RCaCVz",
    "name": "Patient name",
    "required": "boolean",
    "start_offset": "number",
    "type": "API_LOOKUP",
    "context": {}
  }
]

Response Body​

Your API must return an array matching the request order:

[
  {
    "id": "string",
    "value": "any",
    "description": "string | null",
    "meta": {
      "[key: string]": "string | number | boolean | null"
    },
    "accuracy": "number",
    "errorMessage": "string | null",
    "warningMessage": "string | null"
  }
]

Common Use Cases​

  • Customer database lookups
  • Product code validation
  • Address verification services
  • Tax ID number validation
  • Real-time inventory checks