> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cadanapay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Submit KYC

> Submit Know Your Customer (KYC) information for verification



## OpenAPI

````yaml /openapi/workforce-management.yaml post /v1/users/{userId}/kyc
openapi: 3.0.0
info:
  description: APIs for interacting with Cadana Payroll Platform
  version: 1.0.0
  title: Business Workforce Management
  termsOfService: https://cadanapay.com/terms-and-conditions
  contact:
    email: api@cadanapay.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: https://api.cadanapay.com
    description: Prod Server
  - url: https://dev-api.cadanapay.com
    description: Dev Server
security:
  - Authorization: []
tags:
  - name: Custom Auth
    description: APIs for interacting with Custom Authentication
  - name: Persons
    description: APIs for interacting with the HR module
  - name: Milestones
    description: APIs for milestone-based contractor pay
  - name: Instant Pay
    description: APIs for interacting with Instant Pay functionality
  - name: Users
    description: APIs for interacting with employee/contractor Cadana accounts
  - name: Files
    description: APIs for interacting with file uploads
  - name: Payrolls
    description: APIs for interacting with Payroll
  - name: Platform
    description: Platform APIs for interacting with businesses
  - name: Businesses
    description: APIs for interacting with Business
  - name: Contracts
    description: APIs for interacting with contracts
  - name: Sandbox
    description: APIs for relevant sandbox simulations
  - name: Invoices
    description: APIs for interacting with invoices
  - name: Reimbursements
    description: APIs for interacting with reimbursements
  - name: Entities
    description: >-
      APIs for managing legal sub-entities (subsidiaries, branches) under a
      parent business
paths:
  /v1/users/{userId}/kyc:
    post:
      tags:
        - Users
      summary: Submit KYC
      description: Submit Know Your Customer (KYC) information for verification
      operationId: submitUserKYC
      parameters:
        - $ref: '#/components/parameters/userId'
        - $ref: '#/components/parameters/XMultiTenantKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KYCRequest'
            examples:
              userKycSubmission:
                summary: User KYC submission example
                value:
                  firstName: John
                  lastName: Doe
                  dob: '1990-01-15'
                  nationality: US
                  address:
                    line1: 123 Main Street
                    line2: Apt 101
                    city: Anytown
                    postalCode: '12345'
                    state: NY
                    countryCode: US
                  idDetails:
                    type: passport
                    number: '123456789'
                    issuedCountryCode: US
                    issuedBy: Department of State
                    issuedDate: '2020-01-15'
                    expirationDate: '2030-01-15'
                    frontFileId: 1d3f870c-bc91-4636-a0d4-8e54bccf7d64
                    backFileId: 2e4a981d-cd02-4747-b29d-3f65dd8e7d75
                    selfieFileId: 3f5b092e-de13-4858-a40e-4c76ee9f8e86
                  addressProofFileId: 4a6b103f-ef24-4969-b51f-5d87ff0a9f97
      responses:
        '204':
          description: KYC information submitted successfully
        '400':
          $ref: '#/components/responses/BadRequestError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        5XX:
          $ref: '#/components/responses/InternalError'
      security:
        - Authorization: []
components:
  parameters:
    userId:
      name: userId
      in: path
      description: The unique identifier for the user
      required: true
      schema:
        type: string
        format: uuid
    XMultiTenantKey:
      name: X-MultiTenantKey
      in: header
      required: false
      schema:
        type: string
      description: >-
        Required when using a Platform API token. The tenant key identifying
        which business to operate on.
  schemas:
    KYCRequest:
      type: object
      required:
        - firstName
        - lastName
        - dob
        - nationality
        - idDetails
      properties:
        firstName:
          type: string
          description: User's first name
          example: John
        lastName:
          type: string
          description: User's last name
          example: Doe
        dob:
          type: string
          format: date
          description: Date of birth in YYYY-MM-DD format
          example: '1990-01-15'
        nationality:
          type: string
          description: User's nationality (2-letter country code)
          example: US
        address:
          $ref: '#/components/schemas/address'
        idDetails:
          $ref: '#/components/schemas/IdentityDetails'
        addressProofFileId:
          type: string
          format: uuid
          description: File ID for address proof document
          example: 4a6b103f-ef24-4969-b51f-5d87ff0a9f97
    address:
      type: object
      description: Address
      required:
        - countryCode
      properties:
        line1:
          type: string
          example: Street 1
        line2:
          type: string
          example: Apt 1
        city:
          type: string
          example: Gotham
        postalCode:
          type: string
          example: '10001'
        state:
          type: string
          example: NY
        countryCode:
          type: string
          example: US
    IdentityDetails:
      type: object
      required:
        - number
        - type
        - issuedBy
        - issuedDate
        - expirationDate
        - issuedCountryCode
        - frontFileId
        - selfieFileId
      properties:
        number:
          type: string
          example: A12345678
          description: Identification document number
        type:
          type: string
          description: id type
          example: passport
          enum:
            - passport
            - driver_license
            - national_id
            - voter_id_card
            - id_card
            - pan_card
        issuedBy:
          type: string
          example: Nigeria Immigration Service
          description: Authority that issued the document
        issuedDate:
          type: string
          format: date
          example: '2020-01-15'
          description: Date when the document was issued
        expirationDate:
          type: string
          format: date
          example: '2030-01-15'
          description: Date when the document expires
        issuedCountryCode:
          type: string
          example: NG
          description: Country code of the issuing authority
        frontFileId:
          $ref: '#/components/schemas/uuid'
          description: >-
            File ID of the front side of the identification document. In
            sandbox, can be omitted when a sentinel value is used
        backFileId:
          $ref: '#/components/schemas/uuid'
          description: File ID of the back side of the identification document
        selfieFileId:
          $ref: '#/components/schemas/uuid'
          description: >-
            File ID of the selfie with the identification document. In sandbox,
            can be omitted when a sentinel value is used
    BadRequestError:
      description: Bad input provided by client
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            params:
              description: A map for meta data around the error that occurred
              type: object
      example:
        code: invalid_request_body
        message: The request body provided is not valid
        params:
          field: Value is invalid.
    NotFoundError:
      description: Not Found
      allOf:
        - $ref: '#/components/schemas/Error'
      example:
        code: resource_not_found
        message: Requested resource could not be found.
    InternalError:
      description: Internal server error
      allOf:
        - $ref: '#/components/schemas/Error'
      example:
        code: internal_error
        message: An unexpected error occurred. Please try again later.
    uuid:
      type: string
      format: uuid
      example: 8ef9a712-cdae-4110-b1ea-9ba95abbee6e
    Error:
      type: object
      properties:
        code:
          description: A machine parsable error code
          type: string
          enum:
            - invalid_request_body
            - resource_not_found
            - forbidden
            - internal_error
        message:
          description: A human readable message describing the error
          type: string
  responses:
    BadRequestError:
      description: Bad input provided by client
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BadRequestError'
    NotFoundError:
      description: Requested resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/NotFoundError'
    InternalError:
      description: Internal error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/InternalError'
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer
      bearerFormat: API_SECRET_KEY

````