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

# Submit customer verification

> Stores an immutable encrypted verification attempt, submits it for review, and returns the safe asynchronous submission state.



## OpenAPI

````yaml /openapi.json post /v1/customers/{customer_id}/verification-submissions
openapi: 3.0.3
info:
  contact:
    email: support@yara.cash
    name: Yara API Support
  description: >-
    Merchant-facing wallets/address-as-a-service API for creating merchant
    receive addresses, inspecting balances, quoting transfers, and initiating
    payouts to whitelisted recipients.

    Public endpoints are for external integrators. Dashboard endpoints are
    gateway-to-environment surfaces protected by the external API gateway.
    Internal endpoints are platform/system surfaces protected by an internal
    token.
  license:
    name: Proprietary
  title: Yara External API - Public API
  version: '1.0'
servers:
  - url: https://api.yara.cash
security: []
paths:
  /v1/customers/{customer_id}/verification-submissions:
    post:
      tags:
        - public.customer-verification
      summary: Submit customer verification
      description: >-
        Stores an immutable encrypted verification attempt, submits it for
        review, and returns the safe asynchronous submission state.
      parameters:
        - description: Customer ID
          in: path
          name: customer_id
          required: true
          schema:
            type: string
        - description: Idempotency key
          in: header
          name: X-Idempotency-Key
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerVerificationSubmissionCreateRequest'
        description: Tier and customer-type-specific verification fields
        required: true
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerVerificationSubmissionResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    CustomerVerificationSubmissionCreateRequest:
      properties:
        account_purpose:
          type: string
        account_purpose_other:
          type: string
        acting_as_intermediary:
          type: boolean
        associated_persons:
          items:
            $ref: '#/components/schemas/CustomerAssociatedPerson'
          type: array
        birth_date:
          example: '1990-05-15'
          type: string
        business_description:
          type: string
        business_industry:
          items:
            type: string
          type: array
        business_legal_name:
          type: string
        business_type:
          type: string
        bvn:
          example: '22345678901'
          type: string
        conducts_money_services:
          type: boolean
        conducts_money_services_description:
          type: string
        conducts_money_services_using_bridge:
          type: boolean
        documents:
          items:
            $ref: '#/components/schemas/CustomerVerificationDocument'
          type: array
        employment_status:
          type: string
        estimated_annual_revenue_usd:
          type: string
        expected_monthly_payments_usd:
          type: string
        has_material_intermediary_ownership:
          type: boolean
        high_risk_activities:
          items:
            type: string
          type: array
        high_risk_activities_explanation:
          type: string
        identifying_information:
          items:
            $ref: '#/components/schemas/CustomerIdentifyingInformation'
          type: array
        image_url:
          example: https://files.example.com/selfie.jpg
          type: string
        is_dao:
          type: boolean
        most_recent_occupation:
          type: string
        nationality:
          example: NGA
          type: string
        operates_in_prohibited_countries:
          type: boolean
        other_websites:
          items:
            type: string
          type: array
        ownership_threshold:
          type: integer
        physical_address:
          $ref: '#/components/schemas/CustomerVerificationAddress'
        primary_website:
          type: string
        registered_address:
          $ref: '#/components/schemas/CustomerVerificationAddress'
        residential_address:
          $ref: '#/components/schemas/CustomerVerificationAddress'
        source_of_funds:
          type: string
        source_of_funds_description:
          type: string
        tier:
          allOf:
            - $ref: '#/components/schemas/model.VerificationTier'
          enum:
            - TIER_1
            - TIER_2
          example: TIER_1
      type: object
    CustomerVerificationSubmissionResponse:
      properties:
        data:
          $ref: '#/components/schemas/model.VerificationSubmissionAPIResponse'
      type: object
    ErrorResponse:
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      type: object
    CustomerAssociatedPerson:
      properties:
        birth_date:
          example: '1990-05-15'
          type: string
        documents:
          items:
            $ref: '#/components/schemas/CustomerVerificationDocument'
          type: array
        email:
          type: string
        first_name:
          type: string
        has_control:
          type: boolean
        has_ownership:
          type: boolean
        identifying_information:
          items:
            $ref: '#/components/schemas/CustomerIdentifyingInformation'
          type: array
        is_director:
          type: boolean
        is_signer:
          type: boolean
        last_name:
          type: string
        middle_name:
          type: string
        nationality:
          example: NGA
          type: string
        ownership_percentage:
          type: integer
        phone:
          type: string
        relationship_established_at:
          type: string
        residential_address:
          $ref: '#/components/schemas/CustomerVerificationAddress'
        title:
          type: string
      type: object
    CustomerVerificationDocument:
      properties:
        file:
          type: string
        purposes:
          items:
            enum:
              - proof_of_address
              - proof_of_source_of_funds
            type: string
          type: array
      type: object
    CustomerIdentifyingInformation:
      properties:
        expiration:
          example: '2030-01-01'
          type: string
        image_back:
          type: string
        image_front:
          type: string
        issuing_country:
          example: NGA
          type: string
        number:
          type: string
        type:
          enum:
            - passport
            - drivers_license
            - national_id
            - tin
          type: string
      type: object
    CustomerVerificationAddress:
      properties:
        city:
          type: string
        country:
          example: NGA
          type: string
        postal_code:
          type: string
        street_line_1:
          type: string
        subdivision:
          type: string
      type: object
    model.VerificationTier:
      enum:
        - TIER_1
        - TIER_2
      type: string
      x-enum-varnames:
        - VerificationTier1
        - VerificationTier2
    model.VerificationSubmissionAPIResponse:
      properties:
        completed_at:
          type: string
        created_at:
          type: string
        customer_id:
          type: string
        customer_type:
          $ref: >-
            #/components/schemas/github_com_yaracash_yara-api_internal_customer_model.Type
        id:
          type: string
        rejection_reasons:
          items:
            type: string
          type: array
        status:
          $ref: '#/components/schemas/model.VerificationSubmissionStatus'
        submitted_at:
          type: string
        tier:
          $ref: '#/components/schemas/model.VerificationTier'
        updated_at:
          type: string
      type: object
    ErrorBody:
      properties:
        code:
          example: validation_error
          type: string
        message:
          example: invalid JSON body
          type: string
      type: object
    github_com_yaracash_yara-api_internal_customer_model.Type:
      enum:
        - INDIVIDUAL
        - BUSINESS
      type: string
      x-enum-varnames:
        - TypeIndividual
        - TypeBusiness
    model.VerificationSubmissionStatus:
      enum:
        - DRAFT
        - SUBMITTED
        - PENDING
        - VERIFIED
        - REJECTED
        - REQUIRES_REVIEW
      type: string
      x-enum-varnames:
        - VerificationSubmissionStatusDraft
        - VerificationSubmissionStatusSubmitted
        - VerificationSubmissionStatusPending
        - VerificationSubmissionStatusVerified
        - VerificationSubmissionStatusRejected
        - VerificationSubmissionStatusRequiresReview
  securitySchemes:
    ApiKeyAuth:
      description: 'Public merchant API key. You can also send Authorization: ApiKey <key>.'
      in: header
      name: X-Yara-API-Key
      type: apiKey

````