Skip to main content
POST
Get CIPC Enterprise information

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Example: true

This is an indicator to audit the fact that the controller has obtained consent from the subject to process their personal information and data as per the regulatory requirements pertaining to local and global privacy and data protection legislation.

RegistrationNumber
string
required

The client is to provide the registration number of the company.

Minimum string length: 1
CRef
string<string> | null

Example: "REF00001"

This is the unique transaction reference number that can be supplied by the controller. This will be provided in response messages related to the transaction and will be required for identifying transactions for support purposes.

Response

Success

CRef
string<string> | null

This field will return the reference provided by the client to track the transaction.

Status
enum<string>

Status values (static strings) to be used for external connection management

Available options:
Success,
Failure,
Unknown,
AuthFailure,
DataDeserializationError,
EmptyResults,
ErrorContactSupport,
FaceDetectionFailure,
FaceComparisonFailure,
NoStatusDefined,
FaceDetectionQualityTooLow,
FaceDetectionTooManyFaces,
FaceDetectionNoFacesFound,
FaceComparisonError,
FaceComparisonNotSame,
GoldenSourceImageNull,
ProvidedImageNull,
GoldenSourceNoFacesFound,
ProvidedImageNoFacesFound,
GoldenSourceHasTooManyFaces,
ProvidedImageHasTooManyFaces,
GoldenSourceQualityTooLow,
ProvidedImageQualityTooLow,
GoldenSourceGUIDIncorrect,
ProvidedImageGUIDIncorrect,
FaceAPIGeneralError,
FaceAPIPublicUrlInputError,
FaceBadInput,
GoldenSourceIncorrectStringFormat,
ProvidedImageIncorrectStringFormat,
SAFPSNPROk,
SAFPSHANISOk,
SAFPSNIISOk,
SAFPSNPRSlow,
SAFPSHANISSlow,
SAFPSNIISSlow,
SAFPSFailure,
SAFPSPossibleFailure,
SAFPSNPRFailure,
SAFPSHANISFailure,
SAFPSNIISFailure,
FaceTooClose,
EyesClosed,
FaceCloseToBorder,
FaceCropped,
FaceIsOccluded,
FaceNotFound,
TooManyFaces,
FaceTooSmall,
AbsoluteFaceTooSmall,
RelativeFaceTooSmall,
FaceAngleTooLarge,
FailedToPredictLandmarks,
Active,
CSuccess,
AsyncCSuccess,
IdentificationNumberInvalid,
IdentificationNumberAgeBelow18,
UnableToVerifyIdentificationNumberOnDocument,
UnableToVerifyIdentificationNumberAtGoldenSource,
GoldenSourceUnavailable,
MandatoryInformationMissing,
NPRSuccess,
HANISNotAvailable,
InvalidIDNCheckDigitTestNotPassed,
NPRNotAvailableOnlyPhotoIsReturned,
IDNRIsNotCurrentlyAValidNPRIDNR,
IDNRIsMarkedForDeletion
Message
string<string> | null

This will return a status of the transaction s well as external tracking information.

TrackingNumber
string | null

Tracking number of the transaction

CIPCEnterprises
This will return the data obtained from the CIPC on the provided registration number. · object[] | null

A list of CIPC registered companies

TotalRecords
integer<int32>

This will return the total number of records associated with the enterprise.

TotalReturnedRecords
integer<int32>

This will return the total number of returned records associated with the enterprise.

status_message
string | null

This is a string describing the status of the response received.

bh_response_code
string | null

This will return the bh code response.

http_code
string | null

This will return an http code from the response.

request_reference
string | null

This will return a reference to the request to verify an enterprise.