api-docs-icon

Agent Validation

POST
/ v1/ agent-validation

This API will determine the appropriate distribution selling chain for a producer looking to sell a specific product to a client. The API request body provides various fields that can be used to identify the advisor and various fields to identify the General Agency that they are selling through and the Firm if one is involved. It also includes request data that identifies the information key to performing the validation such as the product being sold, the state it is being sold in and the resident state of the person being insured. Based on the distribution selling chain determined, all of the validations that need to be performed will occur and any requirements that are not in good order will be provided in the API response.
























Response




x-trace-id
string

Custom Trace ID Header for Tracking Requests

Example:
035ae04d-a7d1-490d-be6b-bc26d2b9bb0b

additionalDetails
boolean
required

This serves as a flag to indicate that the caller would like to receive detailed information about the validation. Valuing the flag with false will result in the minimal details being returned to the caller; just the overall result and any validation messages for requirements that are not in good order would be returned.

Example:
false
applicationState
string
required

The state that the product sale is taking place.

Example:
NJ
insuredResidentState
string
required

The resident state of the person being insured.

Example:
NJ
signedDate
string
required

The day the new business is being submitted. For pre-submission checks this will be the current date.

Example:
2023-03-31
advisor
union

The advisor portion of the request requires the advisor's Last name and one of 3 different identifier fields that can be used to identify the advisor. Only one identifier field should be included in the api call. Including multiple identifier fields will result in an error being returned.

directResponseGeneralAgency
boolean

If the selling arrangement is a direct response arrangement where the sale is made by a phone rep and the principal for the agency is captured as the writing agent for the policy.

Example:
false
firm
union

The firm portion of the request takes in a name of the firm and one of 3 different fields that can be used to identify the firm. Only one identifier field should be included in the api call along with the name. Including multiple data fields will result in an error being returned.

generalAgency
union

The general agency portion of the request takes in the name of the GA and one of 3 different fields that can be used to identify the general agency. Only one identifier field should be included in the api call along with the name. Including multiple data fields will result in an error being returned.

product
object

Holds the piece of information that needs to be provided to identify the product that is being sold.

Responses

Successful operation

requirementDetails
object

Requirement details for all entities validated, Only included if additionalDetails is set to True in the request.

validationMessages
array<object>

An array of any errors that occurred during the validation process.

object

validationOverallResult
enum

The final result of the validation process. It is a culmination of all the information provided in the requirementDetails section.

Allowed Values:
Producer Can Sell
Producer Cannot Sell
Example:
Producer Can Sell