# /producertransaction/v1/order

Endpoint: POST /producertransaction/v1/order
Version: v1

## Request fields (application/json):

  - `tlq` (object, required)

  - `tlq.juris` (string, required)
    Filing State (Two-Letter State Code).

  - `tlq.pType` (string, required)
    Producer Type (I-Individual, A-Agency).

  - `tlq.fType` (string, required)
    Filing Type (A-Appointment, T-Appointment Termination).

  - `tlq.lType` (string, required)
    LOA (License of Authority) Type (M - Major, L – Limited Lines).

  - `tlq.clientOrderNum` (string, required)
    Client Order Number is a unique reference number for each record that is sent by the client.

  - `tlq.userId` (string, required)
    Xchange User ID assigned to Licensing Center users by RegEd.

  - `tlq.filingMode` (string, required)
    Electronic or Paper Transaction Type (E-Electronic, P-Paper).

  - `data` (object, required)

  - `data.firstName` (string, required)
    Individual’s First Name

  - `data.lastName` (string, required)
    Individual’s Last Name

  - `data.middleInitial` (string,null)
    Individual’s Middle Initial

  - `data.middleName` (string,null)
    Individual’s Middle Name

  - `data.taxId` (string, required)
    Applicant’s SSN or FEIN

  - `data.dateOfBirth` (string,null)
    Individual’s date of birth

  - `data.niprNoReq` (string,null)
    Applicant’s NPN (National Producer Number)

  - `data.currentResidenceAddress` (object)

  - `data.currentResidenceAddress.cResidenceAddress` (string,null)
    Resident Address line 1

  - `data.currentResidenceAddress.cResidenceAddress2` (string,null)
    Resident Address line 2

  - `data.currentResidenceAddress.cResidenceAddressCity` (string,null)
    Resident Address City

  - `data.currentResidenceAddress.cResidenceAddressState` (string,null)
    Resident Address State (2-letter state code)

  - `data.currentResidenceAddress.cResidenceAddressZip` (string,null)
    Resident Address Zip (formats ##### or #####-####)

  - `data.currentResidenceAddress.cResidencePhone` (string,null)
    Resident Phone Number (formats ##########)

  - `data.businessAddress` (object)

  - `data.businessAddress.businessAddressCity` (string,null)
    Business City

  - `data.businessAddress.businessAddressLine1` (string,null)
    Business Address line 1

  - `data.businessAddress.businessAddressLine2` (string,null)
    Business Address line 2

  - `data.businessAddress.businessAddressState` (string,null)
    Business Address State

  - `data.businessAddress.businessAddressZip` (string,null)
    Business Address Zip (formats ##### or #####-####)

  - `data.businessAddress.businessPhone` (string,null)
    Business Phone Number (formats ##########)

  - `data.mailingAddress` (object)

  - `data.mailingAddress.mailAddress1` (string,null)
    Mail Address line 1

  - `data.mailingAddress.mailAddress2` (string,null)
    Mail Address line 2

  - `data.mailingAddress.mailCity` (string,null)
    Mail Address City

  - `data.mailingAddress.mailState` (string,null)
    Mail Address State

  - `data.mailingAddress.mailZip` (string,null)
    Mail Address Zip (formats ##### or #####-####)

  - `data.insurerLicenseDetails` (object)

  - `data.insurerLicenseDetails.insurersLicenseNumber` (string,null)
    Insurer’s State-Specific License Number

  - `data.insurerLicenseDetails.insLicState` (string,null)
    Insurer’s License State (2-letter state code)

  - `data.insurerDetails` (object)

  - `data.insurerDetails.insurerCity` (string,null)
    Insurer’s City

  - `data.insurerDetails.insurerPhone` (string,null)
    Insurer’s Phone Number (formats ##########)

  - `data.insurerDetails.insurerState` (string,null)
    Insurer’s State (2-letter state code)

  - `data.insurerDetails.insurerStreet1` (string,null)
    Insurer’s Street Line 1

  - `data.insurerDetails.insurerStreet2` (string,null)
    Insurer’s Street Line 2

  - `data.insurerDetails.insurerZip` (string,null)
    Insurer’s Zip (formats ##### or #####-####)

  - `data.licenseDetails` (object)

  - `data.licenseDetails.licenseNumber` (string,null)
    Applicant’s State-Specific License Number

  - `data.licenseDetails.licenseState` (string,null)
    Applicant’s License State (2-letter state code)

  - `data.feinNumber` (string,null)
    Sponsoring Company’s FEIN. Required if SponsoringCompany is provided

  - `data.cityDomicile` (string,null)
    Insurer’s City of Domicile (City of Incorporation)

  - `data.insStateDomicile` (string,null)
    Insurer’s Domicile State (State of Incorporation)

  - `data.dateEffective` (string,null)
    Effective Date of Appointment or Appointment Termination

  - `data.naicNum` (string,null)
    Insurer’s NAIC Number. Required if SponsoringCompany is provided

  - `data.authorizedSignerDetails` (object)

  - `data.authorizedSignerDetails.authorizedSignerFirstName` (string,null)
    Authorized Signer’s First Name

  - `data.authorizedSignerDetails.authorizedSignerLastName` (string,null)
    Authorized Signer’s Last Name

  - `data.authorizedSignerDetails.authorizedPersonCity` (string,null)
    Authorized Signer’s City

  - `data.authorizedSignerDetails.authorizedPersonPhone` (string,null)
    Authorized Signer’s Phone Number (formats ##########)

  - `data.authorizedSignerDetails.authorizedPersonState` (string,null)
    Authorized Signer’s State (2-letter state code)

  - `data.authorizedSignerDetails.authorizedPersonStreet1` (string,null)
    Authorized Signer’s Street Line 1

  - `data.authorizedSignerDetails.authorizedPersonTitle` (string,null)
    Authorized Signer’s Title

  - `data.authorizedSignerDetails.authorizedPersonZip` (string,null)
    Authorized Signer’s Zip (formats ##### or #####-####)

  - `data.authorizedSignerDetails.authorizedSignerName` (string,null)
    Authorized Signer’s Full Name

  - `data.authorizedSignerDetails.authorizedSignerEmail` (string,null)
    Authorized Signer’s Email Address

  - `data.contactName` (string,null)
    Name of Contact person at the Insurer

  - `data.contactPhone` (string,null)
    Insurer Contact Person’s Phone Number

  - `data.officerTitle` (string,null)
    Title of Owner/Officer of the Firm

  - `data.loa` (array,null)
    Possible multiple occurrence of Line of Authority in a single transaction

  - `data.domicile` (object)

  - `data.domicile.insStateDomicile` (string,null)
    Insurer's Domicile State (State of Incorporation)

  - `data.companyCodeDetails` (object)

  - `data.companyCodeDetails.companyCodeState` (string,null)
    Insurer’s Company State Code (2-letter state code)

  - `data.companyCodeDetails.companyCode` (string,null)
    Insurer’s Company Code

  - `data.residentStateYN` (string,null)
    Is the filing state the Applicant’s resident state? (Y/N)

  - `data.residentStateText` (string,null)
    Agency Applicant’s Resident State Abbreviation (2-letter state code)

  - `data.ltp` (string,null)
    License Type

  - `data.ltpText` (string,null)
    Text License Type for State (2-letter state code)

  - `data.pinStateFeeDetails` (object)

  - `data.pinStateFeeDetails.pinStateFee` (string,null)
    License Fee Amount for State

  - `data.pinStateFeeDetails.pinFeeState` (string,null)
    State for which License Fee is Charged (2-letter state code)

  - `data.sponsoringCompany` (string,null)
    Name of the Sponsoring Insurance Company

  - `data.firmName` (string,null)
    Agency Applicant’s Full Company Name

  - `data.trm` (string,null)
    Termination code

  - `data.termReasonText` (string,null)
    Text Description of the Termination Reason

  - `data.termCauseYN` (string,null)
    Is this termination “for cause?” (Y/N)

  - `data.surplusLinesYn` (string,null)
    Is the filing for Surplus Lines? (Y/N)

  - `data.floridaResCty` (string,null)
    Applicants County Code in Florida for non-residents

  - `data.floridaCountyCode` (string,null)
    Applicants County Code in Florida for residents

  - `data.appCodeFl` (string,null)
    Applicants class code in Florida

  - `data.costCenter1` (string,null)
    Customer specific cost center value (#1)

  - `data.costCenter2` (string,null)
    Customer specific cost center value (#2)

## Response 200 fields (application/json):

  - `order` (object)

  - `order.orderDetails` (object)

  - `order.orderDetails.clientOrderNumber` (string,null)
    Client Order Number is a unique reference number for each record that is sent by the client.

  - `order.orderDetails.orderNumber` (string,null)
    Confirmation number generated by RegEd when order is created

  - `order.orderDetails.orderSequence` (string,null)
    Confirmation number generated by RegEd when order is created

  - `order.orderDetails.orderStatus` (string,null)
    Current Status of order. (17, 19, 23, 24, 25)

  - `order.orderDetails.niprProcessed` (string,null)
    Is order processed at NIPR? (Y/N)

  - `order.orderDetails.modifiedDate` (string,null)
    Date of last modification of Filing

  - `order.itemDetails` (object)

  - `order.itemDetails.item` (array,null)

  - `order.itemDetails.item.itemNumber` (string,null)
    A unique identifier for each record, generated by RegEd

  - `order.itemDetails.item.serviceType` (string,null)
    Service Type “Appointment” or “Appointment Termination”

  - `order.itemDetails.item.fType` (string,null)
    Filing Type (A-Appointment, T-Appointment Termination).

  - `order.itemDetails.item.taxId` (string,null)
    Applicant’s SSN

  - `order.itemDetails.item.juris` (string,null)
    Filing State (Two-Letter State Code).

  - `order.itemDetails.item.modifiedDate` (string,null)
    Date Order is Created

  - `order.itemDetails.item.sponsoringCompany` (string,null)
    Name of the Sponsoring Insurance Company

  - `order.itemDetails.item.validationStatus` (string,null)
    Validation Status of the Order

  - `order.itemDetails.item.itemStatus` (string,null)
    Numerical Status of an Item

  - `order.itemDetails.item.itemStatusDescription` (string,null)
    Description of Numerical Status of an Item

  - `order.itemDetails.item.itemComments` (string,null)
    Comments from NIPR

  - `order.itemDetails.item.loas` (array,null)
    Possible multiple occurrence of Line of Authority

  - `order.itemDetails.item.loas.description` (string,null)

  - `order.itemDetails.item.loas.niprCode` (string,null)

  - `order.itemDetails.item.loas.effectiveDate` (string,null)
    Effective Date of Appointment or Appointment Termination

  - `order.itemDetails.item.loas.reason` (string,null)

  - `order.itemDetails.item.validationMessages` (array,null)
    Description of missing mandatory fields.

  - `order.itemDetails.target` (string,null)
    Name of Applicant

  - `order.itemDetails.addedDate` (string,null)
    Date Order is Created

## Response 201 fields (application/json):

  - `order` (object)

  - `order.orderDetails` (object)

  - `order.orderDetails.clientOrderNumber` (string,null)
    Client Order Number is a unique reference number for each record that is sent by the client.

  - `order.orderDetails.orderNumber` (string,null)
    Confirmation number generated by RegEd when order is created

  - `order.orderDetails.orderSequence` (string,null)
    Confirmation number generated by RegEd when order is created

  - `order.orderDetails.orderStatus` (string,null)
    Current Status of order. (17, 19, 23, 24, 25)

  - `order.orderDetails.niprProcessed` (string,null)
    Is order processed at NIPR? (Y/N)

  - `order.orderDetails.modifiedDate` (string,null)
    Date of last modification of Filing

  - `order.itemDetails` (object)

  - `order.itemDetails.item` (array,null)

  - `order.itemDetails.item.itemNumber` (string,null)
    A unique identifier for each record, generated by RegEd

  - `order.itemDetails.item.serviceType` (string,null)
    Service Type “Appointment” or “Appointment Termination”

  - `order.itemDetails.item.fType` (string,null)
    Filing Type (A-Appointment, T-Appointment Termination).

  - `order.itemDetails.item.taxId` (string,null)
    Applicant’s SSN

  - `order.itemDetails.item.juris` (string,null)
    Filing State (Two-Letter State Code).

  - `order.itemDetails.item.modifiedDate` (string,null)
    Date Order is Created

  - `order.itemDetails.item.sponsoringCompany` (string,null)
    Name of the Sponsoring Insurance Company

  - `order.itemDetails.item.validationStatus` (string,null)
    Validation Status of the Order

  - `order.itemDetails.item.itemStatus` (string,null)
    Numerical Status of an Item

  - `order.itemDetails.item.itemStatusDescription` (string,null)
    Description of Numerical Status of an Item

  - `order.itemDetails.item.itemComments` (string,null)
    Comments from NIPR

  - `order.itemDetails.item.loas` (array,null)
    Possible multiple occurrence of Line of Authority

  - `order.itemDetails.item.loas.description` (string,null)

  - `order.itemDetails.item.loas.niprCode` (string,null)

  - `order.itemDetails.item.loas.effectiveDate` (string,null)
    Effective Date of Appointment or Appointment Termination

  - `order.itemDetails.item.loas.reason` (string,null)

  - `order.itemDetails.item.validationMessages` (array,null)
    Description of missing mandatory fields.

  - `order.itemDetails.target` (string,null)
    Name of Applicant

  - `order.itemDetails.addedDate` (string,null)
    Date Order is Created


## Response 400 fields

## Response 401 fields

## Response 403 fields

## Response 500 fields