site

The columns, which of them are numeric, the row count and the provenance banner of the Immigration Adviser Finder dataset. Call this first to learn the schema.

{
  "type": "object",
  "properties": {},
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Rows of the Immigration Adviser Finder dataset whose cells contain the query (case-insensitive), up to 50.

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "minLength": 1,
      "description": "text to look for in any cell"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50
    }
  },
  "required": [
    "query"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

The rows of the Immigration Adviser Finder dataset where a column equals a value exactly (case-insensitive).

{
  "type": "object",
  "properties": {
    "column": {
      "type": "string",
      "minLength": 1
    },
    "value": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "column",
    "value"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

The rows of the Immigration Adviser Finder dataset whose column is any of the given values, in the order given — for "X vs Y" questions.

{
  "type": "object",
  "properties": {
    "column": {
      "type": "string",
      "minLength": 1
    },
    "values": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "minItems": 2,
      "maxItems": 10
    }
  },
  "required": [
    "column",
    "values"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

count, min, max, mean, median and sum of a numeric column of the Immigration Adviser Finder dataset (grouping commas and currency are handled; non-numeric rows are excluded and counted).

{
  "type": "object",
  "properties": {
    "column": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "column"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

The highest (or lowest) rows of the Immigration Adviser Finder dataset by a numeric column — "which is the most/least X".

{
  "type": "object",
  "properties": {
    "column": {
      "type": "string",
      "minLength": 1
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50
    },
    "ascending": {
      "type": "boolean",
      "description": "true for the lowest first; default highest first"
    }
  },
  "required": [
    "column"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

The source, the date it was computed, the licence and the citation for the Immigration Adviser Finder dataset. Read this to attribute a figure correctly.

{
  "type": "object",
  "properties": {},
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Which fields the Immigration Adviser Finder register register carries and on how many entities, the regions and services, the identifier schemes, and how to cite it. Call this first.

{
  "type": "object",
  "properties": {},
  "$schema": "http://json-schema.org/draft-07/schema#"
}

The Immigration Adviser Finder register entry for a firm, by its register identifier (scheme + value, e.g. lei) or by the slug of its page. Exact match; returns the whole record with its page.

{
  "type": "object",
  "properties": {
    "scheme": {
      "type": "string",
      "minLength": 2,
      "maxLength": 24,
      "description": "identifier scheme, e.g. lei, fca_frn, tdlr_license"
    },
    "value": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "slug": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    }
  },
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Entities of Immigration Adviser Finder register whose name, commercial name, website, address or authority contains the query, optionally within a region (id or name) and a service (slug or name). Up to 50 rows.

{
  "type": "object",
  "properties": {
    "q": {
      "type": "string",
      "maxLength": 120
    },
    "region": {
      "type": "string",
      "maxLength": 60
    },
    "service": {
      "type": "string",
      "maxLength": 80
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50
    }
  },
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

The Immigration Adviser Finder register entities in one region (a state or a jurisdiction, by id or name), optionally for one service, 50 a page.

{
  "type": "object",
  "properties": {
    "region": {
      "type": "string",
      "minLength": 2,
      "maxLength": 60
    },
    "service": {
      "type": "string",
      "maxLength": 80
    },
    "page": {
      "type": "integer",
      "minimum": 1
    },
    "pageSize": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50
    }
  },
  "required": [
    "region"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Every entity of Immigration Adviser Finder register, 200 a page, with provenance. Needs an access key (Authorization: Bearer); export pages are metered per key per day. Without a key the answer says how to get one.

{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "minimum": 1
    },
    "pageSize": {
      "type": "integer",
      "minimum": 1,
      "maximum": 200
    }
  },
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Read first. States plainly what submit_enquiry does on Immigration Adviser Finder: it starts an enquiry with human providers who quote directly. Nothing is bought, ordered or paid; no quote is guaranteed; it is free. Also returns who receives the details, the consent wording, and how the person confirms.

{
  "type": "object",
  "properties": {},
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Every field of the Immigration Adviser Finder enquiry: key, label, type, whether required, help text and the allowed options where there are any. Pass answers to submit_enquiry keyed by field key.

{
  "type": "object",
  "properties": {},
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Submits an enquiry to Immigration Adviser Finder — NOT a purchase, NOT a guaranteed quote. Step 1: call with the answers (keyed by field key from enquiry_fields) and consent=true; it validates and returns a summary, the consent line and a confirmation token — show the person the summary and the consent line. Step 2: only if the person agrees, call again with the same answers, consent=true and the confirmation token; the enquiry is then submitted, and the person receives an email with a link they must click before any provider sees it. Consent means the person has read and agreed to: "You agree Immigration Adviser Finder may pass these details to one attorney or recognised organisation."

{
  "type": "object",
  "properties": {
    "answers": {
      "type": "object",
      "additionalProperties": {
        "type": [
          "string",
          "number",
          "boolean"
        ]
      },
      "description": "the person's answers, keyed by field key"
    },
    "consent": {
      "type": "boolean",
      "description": "true only when the person has agreed to: You agree Immigration Adviser Finder may pass these details to one attorney or recognised organisation."
    },
    "confirmation": {
      "type": "string",
      "description": "the confirmation token from step 1, after the person has approved the summary"
    }
  },
  "required": [
    "answers",
    "consent"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}