Skip to content

Producer Validation (v1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://reged-developer-portal.redocly.app/_mock/apis/producer-validation/openapi/

Agency

Operations

/producervalidation/v1/agencies/verifycansell

Request

Body
transactionRefGuidstring or null

Callers own transaction tracking GUID

productTypeCodeinteger(int32)required

The product the producer wants to sell
1 - Whole Life
2 - Term
3 - Universal Life
4 - Variable Universal Life
5 - Indexed Universal Life
8 - Variable Whole Life
9 - Fixed Annuity
10 - Variable Annuity
11 - Indexed Annuity
46 - Property, Casualty, and Personal Lines
56 - Registered Indexed Annuity
This is an incomplete list, contact RegEd for additional information.

applicationJurisdictionTypeCodeinteger(int32)(StateCodes)required

1 - Alabama
2 - Alaska
4 - Arizona
5 - Arkansas
6 - California
7 - Colorado
8 - Connecticut
9 - Delaware
10 - District of Columbia
12 - Florida
13 - Georgia
14 - Guam
15 - Hawaii
16 - Idaho
17 - Illinois
18 - Indiana
19 - Iowa
20 - Kansas
21 - Kentucky
22 - Louisiana
23 - Maine
25 - Maryland
26 - Massachusetts
27 - Michigan
28 - Minnesota
29 - Mississippi
30 - Missouri
31 - Montana
32 - Nebraska
33 - Nevada
34 - New Hampshire
35 - New Jersey
36 - New Mexico
37 - New York
38 - North Carolina
39 - North Dakota
41 - Ohio
42 - Oklahoma
43 - Oregon
45 - Pennsylvania
46 - PuertoRico
47 - Rhode Island
48 - South Carolina
49 - South Dakota
50 - Tennessee
51 - Texas
52 - Utah
53 - Vermont
54 - Virgin Islands
55 - Virginia
56 - Washington
57 - West Virginia
58 - Wisconsin
59 - Wyoming

Enum124567891012
applicationSignedDatestring or null(date)

Date the application is signed.

appointbooleanrequired

For clients utilizing the JIT process: if the producer isn't already appointed to sell in the jurisdiction, but is otherwise ready to sell, go ahead and attempt to appoint them in that jurisdiction. For clients not utilizing the JIT process: this can be sent as false

primaryProducerobject(ProducerDetail)required
primaryProducer.​identificationNumberstring[ 1 .. 30 ] charactersrequired

IdentificationNumber can be a NIPR Number, Government ID like an individual Social Security Number (SSN), or an Internal Identifier)

primaryProducer.​identificationTypeinteger(int32)required

What kind of Identifier is being used to identify the Producer:
1 - The IdentificationNumber is a NIPR Number
2 - The IdentificationNumber is a Government ID
3 - The IdentificationNumber is an Internal Identifier

carrierCodestring or null^\d{5}$

Insurance Company's (Carrier) NAIC Code. Only needed for appointment

ownerResidenceStateCodeinteger(int32)(StateCodes)required

1 - Alabama
2 - Alaska
4 - Arizona
5 - Arkansas
6 - California
7 - Colorado
8 - Connecticut
9 - Delaware
10 - District of Columbia
12 - Florida
13 - Georgia
14 - Guam
15 - Hawaii
16 - Idaho
17 - Illinois
18 - Indiana
19 - Iowa
20 - Kansas
21 - Kentucky
22 - Louisiana
23 - Maine
25 - Maryland
26 - Massachusetts
27 - Michigan
28 - Minnesota
29 - Mississippi
30 - Missouri
31 - Montana
32 - Nebraska
33 - Nevada
34 - New Hampshire
35 - New Jersey
36 - New Mexico
37 - New York
38 - North Carolina
39 - North Dakota
41 - Ohio
42 - Oklahoma
43 - Oregon
45 - Pennsylvania
46 - PuertoRico
47 - Rhode Island
48 - South Carolina
49 - South Dakota
50 - Tennessee
51 - Texas
52 - Utah
53 - Vermont
54 - Virgin Islands
55 - Virginia
56 - Washington
57 - West Virginia
58 - Wisconsin
59 - Wyoming

Enum124567891012
secondaryProducersArray of objects or null(ProducerDetail)

Any secondary producers to include in the decision

curl -i -X POST \
  https://reged-developer-portal.redocly.app/_mock/apis/producer-validation/openapi/producervalidation/v1/agencies/verifycansell \
  -H 'Content-Type: application/xml' \
  -d '<root>
    <transactionRefGuid>string</transactionRefGuid>
    <productTypeCode>0</productTypeCode>
    <applicationJurisdictionTypeCode>1</applicationJurisdictionTypeCode>
    <applicationSignedDate>2019-08-24</applicationSignedDate>
    <appoint>true</appoint>
    <primaryProducer>
      <identificationNumber>string</identificationNumber>
      <identificationType>0</identificationType>
    </primaryProducer>
    <carrierCode>string</carrierCode>
    <ownerResidenceStateCode>1</ownerResidenceStateCode>
    <root>
      <identificationNumber>string</identificationNumber>
      <identificationType>0</identificationType>
    </root>
  </root>
  '

Responses

OK

Body
transactionRefGuidstring or null

Callers own transaction tracking GUID returned in the response. Useful for RegEd personnel when tracking any issues between request and response.

transExeDatestring or null

Date of response. In M/d/yyyy format.

transExeTimestring or null

Time of response. In HH:mm:ss tt format.

resultCodeinteger(int32)

Is the producer verified to sell:
1 - Success
2 - Success with validation errors
5 - Fail

errorMessagesArray of objects or null(ValidationError)
Response
<root>
  <transactionRefGuid>string</transactionRefGuid>
  <transExeDate>string</transExeDate>
  <transExeTime>string</transExeTime>
  <resultCode>0</resultCode>
  <root>
    <errorCode>string</errorCode>
    <errorDescription>string</errorDescription>
  </root>
</root>

Agent

Operations