Skip to content

Producer Import (v1)

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

ProducerImport

Operations

/producerimport/v1/agents

Request

Body
BusinessAddressobject(AgentImportAddressModel)
Contactobject(AgentImportContactModel)
CurrentEmploymentobject(AgentImportEmploymentHistoryModel)
Demographicobject(AgentImportDemographicModel)
Hierarchyobject(AgentImportHierarchyModel)
Informationobject(AgentImportInformationModel)
MailingAddressobject(AgentImportAddressModel)
ProfileKeystringnon-emptyrequired
ResidentAddressobject(AgentImportAddressModel)
Ssnstringnon-emptyrequired
curl -i -X POST \
  https://reged-developer-portal.redocly.app/_mock/apis/producer-import/openapi/producerimport/v1/agents \
  -H 'Content-Type: application/xml' \
  -d '<root>
    <BusinessAddress>
      <DynamicData>
        <property1/>
        <property2/>
      </DynamicData>
      <AddressId>0</AddressId>
      <City>string</City>
      <ClientAddressId>string</ClientAddressId>
      <Country>string</Country>
      <County>string</County>
      <FromDate>2019-08-24T14:15:22Z</FromDate>
      <State>string</State>
      <StreetAddress1>string</StreetAddress1>
      <StreetAddress2>string</StreetAddress2>
      <ToDate>2019-08-24T14:15:22Z</ToDate>
      <Zip>string</Zip>
    </BusinessAddress>
    <Contact>
      <DynamicData>
        <property1/>
        <property2/>
      </DynamicData>
      <AdditionalEmailAddress>string</AdditionalEmailAddress>
      <BusinessEmailAddress>string</BusinessEmailAddress>
      <BusinessFaxNumber>string</BusinessFaxNumber>
      <BusinessPhoneExtension>string</BusinessPhoneExtension>
      <BusinessPhoneNumber>string</BusinessPhoneNumber>
      <CellPhoneNumber>string</CellPhoneNumber>
      <HomeEmailAddress>string</HomeEmailAddress>
      <HomeFaxNumber>string</HomeFaxNumber>
      <HomePhoneNumber>string</HomePhoneNumber>
      <SuppressEmail>string</SuppressEmail>
    </Contact>
    <CurrentEmployment>
      <DynamicData>
        <property1/>
        <property2/>
      </DynamicData>
      <City>string</City>
      <Country>string</Country>
      <County>string</County>
      <EmployerName>string</EmployerName>
      <EmploymentId>0</EmploymentId>
      <HireDate>2019-08-24T14:15:22Z</HireDate>
      <InvestmentRelated>string</InvestmentRelated>
      <JobTitle>string</JobTitle>
      <State>string</State>
      <StreetAddress1>string</StreetAddress1>
      <StreetAddress2>string</StreetAddress2>
      <SupervisorName>string</SupervisorName>
      <Zip>string</Zip>
    </CurrentEmployment>
    <Demographic>
      <DynamicData>
        <property1/>
        <property2/>
      </DynamicData>
      <AffiliatedWithBank>string</AffiliatedWithBank>
      <Alias>string</Alias>
      <BackOfficeNrf>string</BackOfficeNrf>
      <BillingCode>string</BillingCode>
      <BranchLocation>string</BranchLocation>
      <CityOfBirth>string</CityOfBirth>
      <CostCenter>string</CostCenter>
      <Country>string</Country>
      <CountryOfBirth>string</CountryOfBirth>
      <CrdNumber>string</CrdNumber>
      <CustomField1>string</CustomField1>
      <CustomField2>string</CustomField2>
      <CustomField3>string</CustomField3>
      <CustomField4>string</CustomField4>
      <CustomField5>string</CustomField5>
      <CustomField6>string</CustomField6>
      <CustomField7>string</CustomField7>
      <CustomField8>string</CustomField8>
      <CustomField9>string</CustomField9>
      <CustomField10>string</CustomField10>
      <DateOfBirth>2019-08-24T14:15:22Z</DateOfBirth>
      <DeptNumber>string</DeptNumber>
      <DriverLicenseNumber>string</DriverLicenseNumber>
      <DriverLicenseState>string</DriverLicenseState>
      <EmployerId>string</EmployerId>
      <EmployersFein>string</EmployersFein>
      <EmpStatus>string</EmpStatus>
      <FirstName>string</FirstName>
      <Gender>string</Gender>
      <HireDate>2019-08-24T14:15:22Z</HireDate>
      <JobTitle>string</JobTitle>
      <LastName>string</LastName>
      <MiddleInitial>string</MiddleInitial>
      <NiprNumber>string</NiprNumber>
      <NmlsRegPriorFirmYn>string</NmlsRegPriorFirmYn>
      <NmlsRenewalDate>2019-08-24T14:15:22Z</NmlsRenewalDate>
      <NmlsRenewalStatus>string</NmlsRenewalStatus>
      <ResidentState>string</ResidentState>
      <RfoCode>string</RfoCode>
      <Salutation>string</Salutation>
      <StateOfBirth>string</StateOfBirth>
      <Suffix>string</Suffix>
      <TerminationDate>2019-08-24T14:15:22Z</TerminationDate>
      <UsCitizen>string</UsCitizen>
    </Demographic>
    <Hierarchy>
      <DynamicData>
        <property1/>
        <property2/>
      </DynamicData>
      <HierarchyCode>string</HierarchyCode>
      <Manager1>string</Manager1>
      <Manager2>string</Manager2>
      <Manager3>string</Manager3>
      <Manager4>string</Manager4>
      <Manager5>string</Manager5>
      <Manager6>string</Manager6>
      <Manager7>string</Manager7>
      <Manager8>string</Manager8>
      <Manager9>string</Manager9>
      <Manager10>string</Manager10>
      <Supervisor>string</Supervisor>
    </Hierarchy>
    <Information>
      <DynamicData>
        <property1/>
        <property2/>
      </DynamicData>
      <IaBrochureSupplementDate>2019-08-24T14:15:22Z</IaBrochureSupplementDate>
      <IaBrochureSupplementRequired>string</IaBrochureSupplementRequired>
      <IaSupervisorName>string</IaSupervisorName>
      <IaSupervisorPhoneNumber>string</IaSupervisorPhoneNumber>
      <IaSupervisorTitle>string</IaSupervisorTitle>
    </Information>
    <MailingAddress>
      <DynamicData>
        <property1/>
        <property2/>
      </DynamicData>
      <AddressId>0</AddressId>
      <City>string</City>
      <ClientAddressId>string</ClientAddressId>
      <Country>string</Country>
      <County>string</County>
      <FromDate>2019-08-24T14:15:22Z</FromDate>
      <State>string</State>
      <StreetAddress1>string</StreetAddress1>
      <StreetAddress2>string</StreetAddress2>
      <ToDate>2019-08-24T14:15:22Z</ToDate>
      <Zip>string</Zip>
    </MailingAddress>
    <ProfileKey>string</ProfileKey>
    <ResidentAddress>
      <DynamicData>
        <property1/>
        <property2/>
      </DynamicData>
      <AddressId>0</AddressId>
      <City>string</City>
      <ClientAddressId>string</ClientAddressId>
      <Country>string</Country>
      <County>string</County>
      <FromDate>2019-08-24T14:15:22Z</FromDate>
      <State>string</State>
      <StreetAddress1>string</StreetAddress1>
      <StreetAddress2>string</StreetAddress2>
      <ToDate>2019-08-24T14:15:22Z</ToDate>
      <Zip>string</Zip>
    </ResidentAddress>
    <Ssn>string</Ssn>
  </root>
  '

Responses

OK

Body
Successboolean
Validationsstring or null
Messagestring or null
Response
<root>
  <Success>true</Success>
  <Validations>string</Validations>
  <Message>string</Message>
</root>

/producerimport/v1/agencies

Request

Body
BusinessAddressobject(FirmImportAddressModel)
ContactsArray of objects or null(FirmImportContactModel)
Demographicobject(FirmImportDemographicModel)
MailingAddressobject(FirmImportAddressModel)
PrimaryAddressobject(FirmImportAddressModel)
ProfileKeystringnon-emptyrequired
Tinstringnon-emptyrequired
curl -i -X POST \
  https://reged-developer-portal.redocly.app/_mock/apis/producer-import/openapi/producerimport/v1/agencies \
  -H 'Content-Type: application/xml' \
  -d '<root>
    <BusinessAddress>
      <DynamicData>
        <property1/>
        <property2/>
      </DynamicData>
      <AddressId>0</AddressId>
      <City>string</City>
      <ClientAddressId>string</ClientAddressId>
      <Country>string</Country>
      <County>string</County>
      <FromDate>2019-08-24T14:15:22Z</FromDate>
      <State>string</State>
      <StreetAddress1>string</StreetAddress1>
      <StreetAddress2>string</StreetAddress2>
      <ToDate>2019-08-24T14:15:22Z</ToDate>
      <Zip>string</Zip>
    </BusinessAddress>
    <root>
      <DynamicData>
        <property1/>
        <property2/>
      </DynamicData>
      <BusinessFaxNumber>string</BusinessFaxNumber>
      <BusinessPhoneExtension>string</BusinessPhoneExtension>
      <BusinessPhoneNumber>string</BusinessPhoneNumber>
      <CellPhoneNumber>string</CellPhoneNumber>
      <ClientContactId>string</ClientContactId>
      <ContactId>0</ContactId>
      <ContactType>string</ContactType>
      <EmailAddress>string</EmailAddress>
      <FirstName>string</FirstName>
      <LastName>string</LastName>
    </root>
    <Demographic>
      <DynamicData>
        <property1/>
        <property2/>
      </DynamicData>
      <AffiliatedWithBank>string</AffiliatedWithBank>
      <BusinessFax>string</BusinessFax>
      <BusinessPhone>string</BusinessPhone>
      <CostCenter>string</CostCenter>
      <FirmBillingCode>string</FirmBillingCode>
      <CustomField1>string</CustomField1>
      <CustomField2>string</CustomField2>
      <CustomField3>string</CustomField3>
      <DbaName>string</DbaName>
      <DomicileCountry>string</DomicileCountry>
      <DomicileState>string</DomicileState>
      <EmailAddress>string</EmailAddress>
      <FirmCrd>string</FirmCrd>
      <FirmId>string</FirmId>
      <FirmName>string</FirmName>
      <IncorporationDate>string</IncorporationDate>
      <Nipr>string</Nipr>
      <OrganizationDate>2019-08-24T14:15:22Z</OrganizationDate>
      <OrganizationType>0</OrganizationType>
      <ParentFirmProfileKey>string</ParentFirmProfileKey>
      <Region>string</Region>
      <StartDate>2019-08-24T14:15:22Z</StartDate>
      <Status>0</Status>
      <TerminationDate>2019-08-24T14:15:22Z</TerminationDate>
      <WebAddress>string</WebAddress>
    </Demographic>
    <MailingAddress>
      <DynamicData>
        <property1/>
        <property2/>
      </DynamicData>
      <AddressId>0</AddressId>
      <City>string</City>
      <ClientAddressId>string</ClientAddressId>
      <Country>string</Country>
      <County>string</County>
      <FromDate>2019-08-24T14:15:22Z</FromDate>
      <State>string</State>
      <StreetAddress1>string</StreetAddress1>
      <StreetAddress2>string</StreetAddress2>
      <ToDate>2019-08-24T14:15:22Z</ToDate>
      <Zip>string</Zip>
    </MailingAddress>
    <PrimaryAddress>
      <DynamicData>
        <property1/>
        <property2/>
      </DynamicData>
      <AddressId>0</AddressId>
      <City>string</City>
      <ClientAddressId>string</ClientAddressId>
      <Country>string</Country>
      <County>string</County>
      <FromDate>2019-08-24T14:15:22Z</FromDate>
      <State>string</State>
      <StreetAddress1>string</StreetAddress1>
      <StreetAddress2>string</StreetAddress2>
      <ToDate>2019-08-24T14:15:22Z</ToDate>
      <Zip>string</Zip>
    </PrimaryAddress>
    <ProfileKey>string</ProfileKey>
    <Tin>string</Tin>
  </root>
  '

Responses

OK

Body
Successboolean
Validationsstring or null
Messagestring or null
Response
<root>
  <Success>true</Success>
  <Validations>string</Validations>
  <Message>string</Message>
</root>