v1
latestOpenAPI 3.0.12026-08-04165266.4 KBRegulation
get/api/Regulation/{schemeNumber}
Path parameters
schemeNumberstring required
Response
Success
regulatedSchemeIdstring uuid
regulatedSchemeNumberstring nullable
parentRegulatedSchemeIdstring uuid nullable
parentRegulatedSchemeNamestring nullable
licencedContactIdstring uuid nullable
licencedContactNamestring nullable
licencedContactNumberstring nullable
submittedByContactIdstring uuid nullable
submittedByContactNumberstring nullable
submittedByContactstring nullable
namestring nullable
regulatedEntityNamestring nullable
regulatedSchemeTypeIdstring uuid
regulatedSchemeTypeNamestring nullable
regulatedSchemeTypeCodestring nullable
schemeLicenceType0 | 200000000 | 200000001
schemeLicenceTypeNamestring nullable
masterAccountstring uuid nullable
masterAccountNamestring nullable
officeNumberstring nullable
firmNumberstring nullable
contactOfficerstring uuid nullable
personalAddressOkayboolean
preferredAddressOkayboolean
localGroupOkayboolean
isSellableboolean
contactOfficerNamestring nullable
contactOfficerNumberstring nullable
schemeLicenceStatus0 | 1 | 2 | 200000000 | 200000001 | 200000002 | 200000003 | 200000004 | 200000005 | 200000006 | 200000007 | 200000008 | 200000009 | 200000010 | 200000011 | 200000012 | 200000013 | 200000014 | 200000015
schemeLicenceStatusNamestring nullable
schemeLicenceStatusReason0 | 200000000 | 200000001 | 200000002 | 200000003 | 200000004 | 200000005 | 200000006 | 200000007 | 200000008 | 200000009 | 200000010 | 200000011 | 200000012 | 200000013 | 200000014 | 200000015 | 200000016
schemeLicenceStatusReasonNamestring nullable
approvalConditionsstring nullable
submissionDatestring date-time nullable
approvalDatestring date-time nullable
licenceEndDatestring date-time nullable
licenceEndReason0 | 200000000 | 200000001 | 200000002 | 200000003 | 200000004 | 200000005 | 200000006 | 200000007 | 200000008 | 200000009 | 200000010 | 200000011 | 200000012 | 200000013 | 200000014 | 200000015 | 200000016
licenceEndReasonNamestring nullable
inclusionReason0 | 200000000 | 200000001
inclusionReasonNamestring nullable
numDirectorPrincipalsinteger nullable
numMemberDirectorPrincipalsinteger nullable
regulatedOrganisationType0 | 200000000 | 200000001 | 200000002 | 200000003 | 200000004 | 200000005
regulatedOrganisationTypeNamestring nullable
isSelfDeclaredAsVrsEligibleboolean
vrsSponsorshipCodestring nullable
isMemberSignoffRequiredboolean
signOffContactIdstring uuid nullable
signOffContactNamestring nullable
signOffContactNumberstring nullable
dateSignedOffstring date-time nullable
alternatePiiUnderwritersstring nullable
clientMoneyTypeinteger
clientMoneyTypeNamestring nullable
gimaStatus0 | 200000000 | 200000001 | 200000002 | 200000003
gimaStatusNamestring nullable
hasPiiboolean nullable
sponsorshipboolean
statusChangeDatestring date-time nullable
startDatestring date-time nullable
renewalsDatestring date-time nullable
responsiblePrincipalIdstring uuid nullable
responsiblePrincipalNamestring nullable
responsiblePrincipalNumberstring nullable
isResponsiblePrincipalValidboolean
memberPiiAndAdrRoute0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8
memberPiiAndAdrRouteNamestring nullable
firmPiiAndAdrRoute0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10
firmPiiAndAdrRouteNamestring nullable
noPiiExplanationstring nullable
createdOnstring date-time
modifiedOnstring date-time nullable
countOfReturnsinteger
countOfMemberDirectorPrincipalsinteger
countOfSubscriptionsinteger