© Adviser Technologies Limited t/as Adviser.ai – Privacy Policy
API Fields
To ensure correct data handling and configuration when using the Adviser.ai API, it is crucial to adhere to the data format specifications outlined in the available fields table. This guide provides a comprehensive overview of the required and optional parameters, including their types,
Parameters Overview
| Parameter | Field Type | Required? | Description |
|---|---|---|---|
| assign – either “adviser” or “allocate” | enum | required | Specifies assignment mode. Can be “adviser” for full name or “allocate” for automatic allocation. |
| schedule – either “weekly”, “monthly”, “fortnightly” | enum | required | Determines the schedule for sending emails: “weekly”, “monthly”, or “fortnightly”. Only for Dead campaign |
| crmnumber | string | required | A reference number for identifying and linking to a CRM. |
| surname | string | required | Customer’s surname. |
| forename | string | required | Customer’s forename. |
| string | Optional if SMS is set | Customer’s email address. Either email or SMS must be provided. | |
| SMS | string | Optional if email is set | Customer’s mobile number. Either email or SMS must be provided. |
| providername | string | Dependent on Data Category ID | The “providername” field, which specifies the policy insurer’s name, has specific requirements depending on the Data Category ID (DCID). DCID 1: The “providername” field is optional. It can be included if available, but it is not mandatory for this data category. DCID 2 – 5: The “providername” field is required. You must provide the insurer’s name for these data categories to ensure proper processing and validation of the data. |
| policytype | string | Dependent on Data Category ID | The “policytype” field in your API requests must correspond exactly with a predefined list of policy types available in the API Control Panel. DCID 1: The “policytype” field is optional. It can be included if available, but it is not mandatory for this data category. DCID 2 – 5: The “policytype” field is required. This strict requirement ensures that the policy type data is standardized and accurately processed by the Adviser.ai system. |
| policynumber | string | Dependent on Data Category ID | The “policynumber” field is used to provide the unique identifier for a policy, as assigned by the insurer. DCID 1 – 2: The “policynumber” field is optional. It can be included if available, but it is not mandatory for this data category. DCID 3 – 5: The “policynumber” field is required. This number is crucial for tracking and managing individual policies and must be included accurately in your API requests. |
| singlejoint | enum | Dependent on Data Category ID | The “singlejoint” field in the Adviser.ai API is used to specify the type of coverage a policy provides. DCID 1 – 2: The “singlejoint” field is optional. It can be included if available, but it is not mandatory for this data category. DCID 3 – 5: The “singlejoint” field is required. This field indicates whether the policy covers a single individual or multiple individuals under a joint cover. |
| policystartdate | string | Dependent on Data Category ID | The “policystartdate” field in the Adviser.ai API is used to specify the date when the policy coverage begins. DCID 1 – 2: The “policystartdate” field is optional. It can be included if available, but it is not mandatory for this data category. DCID 3 – 5: The “policystartdate” field is required. This field is crucial for accurately determining the policy’s duration and ensuring that coverage details are correctly recorded. |
| adviserscorename | string | Dependent on Data Category ID | The “adviserscorename” field in the Adviser.ai API is used to specify the name of the adviser who sold the policy. DCID 1,2,3 & 5: The “adviserscorename” field is optional. It can be included if available, but it is not mandatory for this data category. DCID 4: The “adviserscorename” field is required. This information is important for tracking and attributing policy sales to specific advisers, facilitating performance evaluation, and maintaining records. |
| brandname | string | optional | A free label used for marketing partner names |
| leadstatus | string | optional | A free label used to pass the lead status of the policy |
| leadgenerated_datetime | string | optional | A date stamp in YY-mm-dd HH:SS format |
| campaignreference | string | optional | A free label for the campaign. |
| allowduplicate | enum | optional | Defines rules for handling duplicates. Refer to the ‘Filter/Blocks’ section for details. |
Key Considerations
- Data Category Dependency:
- Fields like “providername”, “policytype”, “policynumber”, “singlejoint”, “policystartdate”, and “adviserscorename” may be required or optional depending on the specific Data Category ID associated with the campaign.
- Field Formatting:
- Dates: Must follow specific formats such as dd-mm-yyyy for policystartdate and YY-mm-dd HH:SS for “leadgenerated_datetime”.
- Enums: Ensure enum values like assign, schedule, and “singlejoint” strictly adhere to the allowed set of values.
- Optional Fields:
- Optional fields can enhance the data’s richness but are not mandatory. Their inclusion depends on the specific requirements of the campaign or internal data management processes.
- Mutually Exclusive Fields:
- The fields email and SMS are mutually exclusive, meaning at least one must be provided, but both are not mandatory if one is present.
By following these guidelines, you can ensure that your API requests to Adviser.ai are well-structured and compliant with the expected data formats. This adherence is crucial for accurate data processing and campaign execution.