> ## Documentation Index > Fetch the complete documentation index at: https://docs.didx.co.za/llms.txt > Use this file to discover all available pages before exploring further. # Get CIPC Enterprise information > This is a service that requests the information of a CIPC Registered company for verification purposes. ## OpenAPI ````yaml products/didx-verify/api-reference/v1/openapi.json post /Citizen/CIPCCheckEnterprise openapi: 3.0.1 info: title: SecureCitizen.Citizen.Api description: >- This is the API documentation for Secure Citizen products. Should you require further information please contact us on the email provided. contact: name: Api Contant Name email: support@securecitizen.co.za license: name: Proprietary url: https://www.securecitizen.co.za version: v1 x-logo: url: >- https://securecitizen.co.za/wp-content/uploads/2022/11/Untitled-design-14.svg altText: Secure Citizen servers: - url: https://citizen.uat.securecitizen.cloud security: [] tags: - name: Citizen description: This details information we can replace to describe this endpoint - name: CitizenV description: This details information we can replace to describe this endpoint - name: CustomClient description: This details information we can replace to describe this endpoint - name: Partner description: This details information we can replace to describe this endpoint paths: /Citizen/CIPCCheckEnterprise: post: tags: - Citizen summary: Get CIPC Enterprise information description: >- This is a service that requests the information of a CIPC Registered company for verification purposes. operationId: CIPCCheckEnterprise requestBody: content: application/json: schema: $ref: '#/components/schemas/CitizenCIPCCheckEnterprise' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CIPCCheckEnterpriseResponse' '401': description: Unauthenticated '403': description: Unauthorized access to this resource '500': description: Cat-as-trophy security: - oauth2: - sc-citizen components: schemas: CitizenCIPCCheckEnterprise: required: - ConsentReceived - RegistrationNumber type: object properties: CRef: title: Client Reference type: string description: "Example: \"REF00001\"\r\n\r\nThis 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." format: string nullable: true ConsentReceived: title: Consent Received type: boolean description: "Example: true\r\n\r\nThis 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." format: bool RegistrationNumber: title: Registration Number minLength: 1 type: string description: The client is to provide the registration number of the company. additionalProperties: false CIPCCheckEnterpriseResponse: type: object properties: CRef: title: Client Reference type: string description: >- This field will return the reference provided by the client to track the transaction. format: string nullable: true Status: $ref: '#/components/schemas/ExternalStatusEnums' Message: title: Message type: string description: >- This will return a status of the transaction s well as external tracking information. format: string nullable: true TrackingNumber: title: Tracking Number type: string description: Tracking number of the transaction nullable: true CIPCEnterprises: title: >- This will return the data obtained from the CIPC on the provided registration number. type: array items: $ref: '#/components/schemas/CIPCEnterprise' description: A list of CIPC registered companies nullable: true TotalRecords: title: Record count type: integer description: >- This will return the total number of records associated with the enterprise. format: int32 TotalReturnedRecords: title: Ruterned record count type: integer description: >- This will return the total number of returned records associated with the enterprise. format: int32 status_message: title: Status message type: string description: This is a string describing the status of the response received. nullable: true bh_response_code: title: Response code type: string description: This will return the bh code response. nullable: true http_code: title: HTTP Code type: string description: This will return an http code from the response. nullable: true request_reference: title: Request Reference type: string description: This will return a reference to the request to verify an enterprise. nullable: true additionalProperties: false ExternalStatusEnums: title: Status enum: - 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 type: string description: >- Status values (static strings) to be used for external connection management format: string CIPCEnterprise: type: object properties: RegistrationNumber: title: Registration Number type: string description: >- This will return the registration number of the company as recorded by the CIPC. nullable: true EnterpriseNumber: title: Enterprise Number type: string description: >- This will return the enterprise number associated with the provided registration number. nullable: true EnterpriseName: title: Enterprise Name type: string description: This will return the enterprise name of the company. nullable: true ShortName: title: Abbreviated Enterprise Name type: string description: >- In the event that the company name has been abbreviated, this will return the abbreviated name of the company. nullable: true RegistrationDate_OnFile: title: Registration Date type: string description: >- This will return the date when the company was registrated as a CIPC enterprise. nullable: true BusinessStartDate_OnFile: title: Business Start Date type: string description: >- This will return the date when the company began operating as a CIPC enterprise. nullable: true StatusCode: title: Status code type: string description: >- This field will return the code to indicate the status of the company being verified. nullable: true StatusDate: title: Status Date type: string description: >- This field will return the date of the most recent change to the status of the company. nullable: true Status: title: Status type: string description: This will return a description of the status of the enterprise nullable: true Sic_Code: title: SIC Codes type: string description: >- This will return the Standard Industrial Classification (SIC) code associated with the enterprise being verified nullable: true Sic_Code_Description: title: SIC Code Description type: string description: >- This is the description associated to the code which indicates the pre-classified industry the enterprises business activity occurs. nullable: true FinancialYearEnd: title: Financial Year End type: integer description: This will return the date of enterprises financial year end. format: int32 FinancialYearEnd_EffectiveDate: title: Financial Year End Effective Date type: string description: >- This will indicate date on which the fiscal year-end of the enterprise will formally begin. nullable: true PhysicalAddressLine1: title: Address Line 1 type: string description: First line of physical address nullable: true PhysicalAddressLine2: title: Address Line 2 type: string description: Second line of physical address nullable: true PhysicalAddressLine3: title: Physical Address (City) type: string description: Third line of physical address nullable: true PhysicalAddressLine4: title: Physcial Address (Province) type: string description: Fourth line of physical address nullable: true PhysicalAddressPostCode: title: Physcial Address (Postal Code) type: string description: Postal code of physical address nullable: true PostalAddressLine1: title: Postal Address Line 1 type: string description: First line of postal address nullable: true PostalAddressLine2: title: Postal Address Line 2 type: string description: Second line of postal address nullable: true PostalAddressLine3: title: Postal Address (City) type: string description: Third line of postal address nullable: true PostalAddressLine4: title: Postal Address (Province) type: string description: Fourth line of postal address nullable: true PostalAddressPostCode: title: Postal Address (Postal Code) type: string description: Fourth line of postal address nullable: true CountryCode: title: Country Code type: string description: >- This will return the code used to identify the country in which the enterprise operates. nullable: true TaxNumber: title: Enterprise Tax Number type: string description: This will return the tax number associated with the enterprise. nullable: true RegistrationDate: title: Date of Registration type: string description: >- This will return the date on which the enterprise was registered with the CIPC nullable: true BusinessStartDate: title: Business Start Date type: string description: This field will return the official start date if the enterprise. nullable: true RecordDate: title: Record Date type: string description: This field will return the date that the enterprise was recorded. nullable: true Source: title: Source type: string description: This field will indicate the source of the information nullable: true Reference: title: Reference String type: string description: This will indicate the reference to the record provided. nullable: true CompanyTypeCode: title: Company Type Code type: string description: >- This field will return the code assigned to the company type under which the enterprise is categorised nullable: true CompanyType: title: Company Type type: string description: This field will return the category enterprise falls under nullable: true ChangeTypeCode: title: Change Type Code type: string description: >- This field will return the code assigned to the change that an enterprise has undergone. nullable: true ChangeType: title: Change Type type: string description: >- This field will return the description of the change that was undergone by an enterprise. nullable: true TelephoneNumber: title: Telephone Numbers List type: array items: {} description: >- This will return a list of telephone numbers associated with the enterprise. nullable: true additionalProperties: false securitySchemes: oauth2: type: oauth2 flows: authorizationCode: authorizationUrl: https://sts.uat.securecitizen.cloud/connect/authorize tokenUrl: https://sts.uat.securecitizen.cloud/connect/token scopes: sc-citizen: SecureCitizen.Citizen.Api ````