Skip to main content

Registration Datasets

The datasets shown in the table below are available as part of the Registration API.

The API platform utilizes the concept of datasets to deliver a variety of data via the GET Data and POST Data endpoints. All datasets are associated with a dataset group and have a dataset name. Therefore the GET Data and POST data endpoints utilize the following structure:

/data/group/{group name}/name/{dataset name}

Utilize the /metadata/group/{group name}/name/{dataset name} endpoint to retrieve details of the fields for each dataset.

 

IMPORTANT:

  1. Only the test datasets are available using your API Developer Center credentials obtained via the REQUEST TEST ACCESS menu option. The production datasets will only be available once you have gone through the production provisioning process, for those datasets requiring production provisioning (as shown in the table below).
  2. The test datasets contain mock or fictional data that is representative of the type of data that will be found in production.

 

API dataset group name dataset name test dataset name status production provisioning required
Registration Firm        
NEW   registeredIndividualRegistrationStatusHistory registeredIndividualRegistrationStatusHistory available yes
NEW   registeredIndividualBranchOfficeLocations registeredIndividualBranchOfficeLocationsMock available yes
    registeredIndividualDisclosureFilings registeredIndividualDisclosureFilingsMock available yes
    registeredIndividualRegistrationStatusHistory registeredIndividualRegistrationStatusHistoryMock available yes
    registeredIndividual registeredIndividualMock available yes
    registeredIndividualContinuingEducation registeredIndividualContinuingEducationMock available yes
    registeredIndividualDeficiencies registeredIndividualDeficienciesMock available yes
    registeredIndividualDisclosures registeredIndividualDisclosuresMock available yes
    registeredIndividualEmployments registeredIndividualEmploymentsMock available yes
    registeredIndividualExams registeredIndividualExamsMock available yes
    registeredIndividualProfessionalDesignations registeredIndividualProfessionalDesignationsMock available yes
    registeredIndividualRegistrations registeredIndividualRegistrationsMock available yes
    registeredIndividualResidentialLocations registeredIndividualResidentialLocationsMock available yes
           
NEW   branchOfficeRegistrations branchOfficeRegistrationsMock available yes
    branchOffice branchOfficeMock available yes
    branchOfficeDetails branchOfficeDetailsMock available yes
    branchOfficeLocations branchOfficeLocationsMock available yes
    branchOfficeFinancialActivities branchOfficeFinancialActivitiesMock available yes
    branchOfficeAssociatedIndividuals branchOfficeAssociatedIndividualsMock available yes
           
NEW   firmRegistrations firmRegistrationsMock available yes
NEW   firmDisclosures firmDisclosuresMock available yes