Skip to content

Producer Transaction (v1)

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

ProducerTransaction

Operations

/producertransaction/v1/order

Request

Body
tlqobject(CreateOrderInputTlqData)required
tlq.​jurisstring= 2 charactersrequired

Filing State (Two-Letter State Code).

tlq.​pTypestring= 1 charactersrequired

Producer Type (I-Individual, A-Agency).

tlq.​fTypestring= 1 charactersrequired

Filing Type (A-Appointment, T-Appointment Termination).

tlq.​lTypestring= 1 charactersrequired

LOA (License of Authority) Type (M - Major, L – Limited Lines).

tlq.​clientOrderNumstring[ 1 .. 20 ] characters[a-zA-Z0-9]+required

Client Order Number is a unique reference number for each record that is sent by the client.

tlq.​userIdstring[ 1 .. 12 ] charactersrequired

Xchange User ID assigned to Licensing Center users by RegEd.

tlq.​filingModestring= 1 charactersrequired

Electronic or Paper Transaction Type (E-Electronic, P-Paper).

dataobject(CreateOrderInputData)required
data.​firstNamestring[ 0 .. 80 ] charactersrequired

Individual’s First Name

data.​lastNamestring[ 0 .. 80 ] charactersrequired

Individual’s Last Name

data.​middleInitialstring or null[ 0 .. 3 ] characters

Individual’s Middle Initial

data.​middleNamestring or null[ 0 .. 30 ] characters

Individual’s Middle Name

data.​taxIdstring[ 9 .. 12 ] characters([0-9]+)required

Applicant’s SSN or FEIN

data.​dateOfBirthstring or null[ 0 .. 10 ] characters

Individual’s date of birth

data.​niprNoReqstring or null[ 0 .. 10 ] characters

Applicant’s NPN (National Producer Number)

data.​currentResidenceAddressobject(CurrentResidenceAddress)
data.​businessAddressobject(BusinessAddress)
data.​mailingAddressobject(MailingAddress)
data.​insurerLicenseDetailsobject(InsurerLicenseDetails)
data.​insurerDetailsobject(InsurerDetails)
data.​licenseDetailsobject(LicenseDetails)
data.​feinNumberstring or null[ 9 .. 80 ] characters([0-9]{9})

Sponsoring Company’s FEIN. Required if SponsoringCompany is provided

data.​cityDomicilestring or null[ 0 .. 80 ] characters

Insurer’s City of Domicile (City of Incorporation)

data.​insStateDomicilestring or null= 2 characters

Insurer’s Domicile State (State of Incorporation)

data.​dateEffectivestring or null[ 0 .. 10 ] characters

Effective Date of Appointment or Appointment Termination

data.​naicNumstring or null[ 0 .. 5 ] characters^[0-9]+$

Insurer’s NAIC Number. Required if SponsoringCompany is provided

data.​authorizedSignerDetailsobject(AuthorisedSignerDetails)
data.​contactNamestring or null[ 0 .. 160 ] characters

Name of Contact person at the Insurer

data.​contactPhonestring or null(tel)[ 0 .. 10 ] characters

Insurer Contact Person’s Phone Number

data.​officerTitlestring or null[ 0 .. 80 ] characters

Title of Owner/Officer of the Firm

data.​loaArray of strings or null

Possible multiple occurrence of Line of Authority in a single transaction

data.​domicileobject(Domicile)
data.​companyCodeDetailsobject(CompanyCodeDetails)
data.​residentStateYNstring or null[ 0 .. 1 ] characters

Is the filing state the Applicant’s resident state? (Y/N)

data.​residentStateTextstring or null= 2 characters

Agency Applicant’s Resident State Abbreviation (2-letter state code)

data.​ltpstring or null[ 0 .. 100 ] characters

License Type

data.​ltpTextstring or null[ 0 .. 2 ] characters

Text License Type for State (2-letter state code)

data.​pinStateFeeDetailsobject(PinStateFeeDetails)
data.​sponsoringCompanystring or null[ 0 .. 150 ] characters

Name of the Sponsoring Insurance Company

data.​firmNamestring or null[ 0 .. 100 ] characters

Agency Applicant’s Full Company Name

data.​trmstring or null[ 0 .. 100 ] characters

Termination code

data.​termReasonTextstring or null[ 0 .. 150 ] characters

Text Description of the Termination Reason

data.​termCauseYNstring or null[ 0 .. 1 ] characters

Is this termination “for cause?” (Y/N)

data.​surplusLinesYnstring or null[ 0 .. 1 ] characters

Is the filing for Surplus Lines? (Y/N)

data.​floridaResCtystring or null[ 0 .. 2 ] characters

Applicants County Code in Florida for non-residents

data.​floridaCountyCodestring or null[ 0 .. 2 ] characters

Applicants County Code in Florida for residents

data.​appCodeFlstring or null[ 0 .. 4 ] characters

Applicants class code in Florida

data.​costCenter1string or null[ 0 .. 25 ] characters

Customer specific cost center value (#1)

data.​costCenter2string or null[ 0 .. 25 ] characters

Customer specific cost center value (#2)

curl -i -X POST \
  https://reged-developer-portal.redocly.app/_mock/apis/producer-transaction/openapi/producertransaction/v1/order \
  -H 'Content-Type: application/json' \
  -d '{
    "tlq": {
      "juris": "FL",
      "pType": "I",
      "fType": "A",
      "lType": "M",
      "clientOrderNum": "ClientOrderNumber",
      "userId": "UserId",
      "filingMode": "E"
    },
    "data": {
      "firstName": "FirstName",
      "lastName": "LastName",
      "middleInitial": "Mr.",
      "middleName": "MiddleName",
      "taxId": "123456789",
      "dateOfBirth": "09/04/1985",
      "niprNoReq": "NPNCode",
      "currentResidenceAddress": {
        "cResidenceAddress": "Current residence addr 1",
        "cResidenceAddress2": "Current residence addr 2",
        "cResidenceAddressCity": "Current Residence City",
        "cResidenceAddressState": "NY",
        "cResidenceAddressZip": "12345-6789",
        "cResidencePhone": "5555555555"
      },
      "businessAddress": {
        "businessAddressCity": "Business City",
        "businessAddressLine1": "Business address line 1",
        "businessAddressLine2": "Business address line 2",
        "businessAddressState": "NY",
        "businessAddressZip": "12345-6788",
        "businessPhone": "5555555554"
      },
      "mailingAddress": {
        "mailAddress1": "Mailing address 1",
        "mailAddress2": "Mailing address 2",
        "mailCity": "Mailing city",
        "mailState": "NY",
        "mailZip": "12345-6787"
      },
      "insurerLicenseDetails": {
        "insurersLicenseNumber": "InsurersLicenseNumber",
        "insLicState": "NY"
      },
      "insurerDetails": {
        "insurerCity": "Insurer city",
        "insurerPhone": "5555555553",
        "insurerState": "NY",
        "insurerStreet1": "Insurer street 1",
        "insurerStreet2": "Insurer street 2",
        "insurerZip": "12345-6786"
      },
      "licenseDetails": {
        "licenseNumber": "LicenseNumber",
        "licenseState": "NY"
      },
      "feinNumber": "123456788",
      "cityDomicile": "Domicile city",
      "insStateDomicile": "NY",
      "dateEffective": "31/12/2027",
      "naicNum": "12345",
      "authorizedSignerDetails": {
        "authorizedSignerFirstName": "SignerFirstName",
        "authorizedSignerLastName": "SignerLastName",
        "authorizedPersonCity": "Signer city",
        "authorizedPersonPhone": "5555555552",
        "authorizedPersonState": "NY",
        "authorizedPersonStreet1": "Signer street",
        "authorizedPersonTitle": "Signer title",
        "authorizedPersonZip": "12345-6786",
        "authorizedSignerName": "SignerName",
        "authorizedSignerEmail": "signer@email.com"
      },
      "contactName": "Contact name",
      "contactPhone": "5555555551",
      "officerTitle": "Officer title",
      "loa": [
        "AIRCRAFT",
        "HEALTH"
      ],
      "domicile": {
        "insStateDomicile": "State of incorporation"
      },
      "companyCodeDetails": {
        "companyCodeState": "NY",
        "companyCode": "CompanyCode"
      },
      "residentStateYN": "Y",
      "residentStateText": "NY",
      "ltp": "AGENT",
      "ltpText": "NY",
      "pinStateFeeDetails": {
        "pinStateFee": "Fee amount",
        "pinFeeState": "NY"
      },
      "sponsoringCompany": "Sponsoring company name",
      "firmName": "Agency Applicant'\''s full company name",
      "trm": "APPLICANT MOVED",
      "termReasonText": "Termination reason",
      "termCauseYN": "N",
      "surplusLinesYn": "Y",
      "floridaResCty": "AB",
      "floridaCountyCode": "CD",
      "appCodeFl": "1234",
      "costCenter1": "Customer cost center 1",
      "costCenter2": "Customer cost center 2"
    }
  }'

Responses

Existing Order was updated.

Body
orderobject(Order)
Response
{
  "order": {
    "orderDetails": { … },
    "itemDetails": { … }
  }
}

/producertransaction/v1/order/status

Request

Query
order_numstring[ 0 .. 20 ] characters
curl -i -X GET \
  'https://reged-developer-portal.redocly.app/_mock/apis/producer-transaction/openapi/producertransaction/v1/order/status?order_num=string'

Responses

OK

Body
orderobject(Order)
Response
{
  "order": {
    "orderDetails": { … },
    "itemDetails": { … }
  }
}