> ## 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 All CIPC Enterprise Directors

> This is a service that requests the information of directors of a CIPC Registered company for verification purposes.



## OpenAPI

````yaml products/didx-verify/api-reference/v1/openapi.json post /Citizen/CIPCCheckDirectors
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/CIPCCheckDirectors:
    post:
      tags:
        - Citizen
      summary: Get All CIPC Enterprise Directors
      description: >-
        This is a service that requests the information of directors of a CIPC
        Registered company for verification purposes.
      operationId: CIPCCheckDirectors
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CitizenCIPCCheckDirctors'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CIPCCheckDirectorsResponse'
        '401':
          description: Unauthenticated
        '403':
          description: Unauthorized access to this resource
        '500':
          description: Cat-as-trophy
      security:
        - oauth2:
            - sc-citizen
components:
  schemas:
    CitizenCIPCCheckDirctors:
      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
    CIPCCheckDirectorsResponse:
      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
        CIPCDirectors:
          title: CIPC Directors
          type: array
          items:
            $ref: '#/components/schemas/CIPCDirector'
          description: A list of all the enterprises directors
          nullable: true
        TotalRecords:
          title: Total Record Count
          type: integer
          description: >-
            This will return the total number of records associated with the
            enterprise.
          format: int32
        TotalReturnedRecords:
          title: Returned 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: BH Response
          type: string
          description: A string related to the BH Response Code
          nullable: true
        http_code:
          title: HTTP Code
          type: string
          description: Code associated with HTTP
          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
    CIPCDirector:
      type: object
      properties:
        IDNumber:
          title: CIPC Director ID Number
          type: string
          description: This will return the ID number of the Director.
          nullable: true
        IDNumberTen:
          title: First 10 digits of ID
          type: string
          description: This will return the first 10 digits of the ID number.
          nullable: true
        RegistrationNumber:
          title: Registration Number
          type: string
          description: >-
            This will return the registration number of the company as recorded
            by the CIPC.
          nullable: true
        CompanyName:
          title: Companys' Name
          type: string
          description: >-
            This will return the name of the company whose directors are being
            checked.
          nullable: true
        CompanyStatus:
          title: Companys' CIPC Status
          type: string
          description: >-
            This will return the status of the company whose directors are being
            checked
          nullable: true
        CompanyType:
          title: Companys' CIPC Type
          type: string
          description: This field will return the category enterprise falls under.
          nullable: true
        CompanySize:
          title: Size of Company
          type: string
          description: >-
            This field will return information regarding the size of the
            enterprise.
          nullable: true
        DirectorStatusCode:
          title: Status Code of Director
          type: string
          description: >-
            This field will return the code associated with the known status of
            the company.
          nullable: true
        DirectorStatus:
          title: Status of Director
          type: string
          description: This field will return the known status of the company.
          nullable: true
        MaxStatusDate:
          title: Max Status Date
          type: string
          description: >-
            This will indicate the most recent date from which the status of the
            Director�s information was derived
          nullable: true
        PersonName:
          title: Directors' Name
          type: string
          description: This will returm the name of the director.
          nullable: true
        ResignationDate:
          title: Resignation Date
          type: string
          description: This will return the date on which the Director was registered.
          nullable: true
        AppointmentDate:
          title: Appointment Date
          type: string
          description: This will return the date on which the Director was appointed.
          nullable: true
        ValidID:
          title: ID Valid
          type: boolean
          description: >-
            This gives an indication of whether the ID of the Director is valid
            or not
        IDNameMatch:
          title: ID Name Match
          type: string
          description: >-
            This will indicate whether the Name provided by the Director matches
            the name found on their ID.
          nullable: true
        Source:
          title: Information Source
          type: string
          description: This field will indicate the source of the informations
          nullable: true
        Reference:
          title: Source Reference
          type: string
          description: This will indicate the reference to the record provided.
          nullable: true
        UsingExtraPersonDetails:
          title: Using Extra Person Details
          type: boolean
          description: >-
            This will indicate whether the information on the director was
            supplemented.
        DirectorTypeCode:
          title: Director Type Code
          type: string
          description: This will indicate the code associated with the type of director.
          nullable: true
        DirectorType:
          title: Director Type
          type: string
          description: This will indicate the type of director in question.
          nullable: true
        Country:
          title: Directors' Countrty
          type: string
          description: This will indicate the country in which the director resides.
          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

````