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

# Get compliance requirements for a compliance



## OpenAPI

````yaml https://sandbox-api.borderless.xyz/v1/api-json get /v1/identities/{identityId}/compliance-checks/{slug}/requirements
openapi: 3.0.0
info:
  title: Borderless API
  description: The Borderless API documentation.
  version: '1.0'
  contact: {}
servers:
  - url: https://sandbox-api.borderless.xyz
security: []
tags: []
paths:
  /v1/identities/{identityId}/compliance-checks/{slug}/requirements:
    get:
      tags:
        - Compliance Checks
      summary: Get compliance requirements for a compliance
      operationId: ComplianceCheckController_getComplianceRequirements
      parameters:
        - name: identityId
          required: true
          in: path
          schema:
            type: string
        - name: slug
          required: true
          in: path
          schema:
            type: string
        - name: redirectUrl
          required: false
          in: query
          description: Optional redirect URL after compliance check
          schema:
            type: string
        - name: sourceAccountId
          required: false
          in: query
          description: >-
            Source account whose owning business identity scopes the compliance
            check (providers with per-business-identity credentials). Pass the
            same account used as sourceAccountId on deposits.
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComplianceCheckRequirements'
      security:
        - bearer: []
components:
  schemas:
    ComplianceCheckRequirements:
      type: object
      properties:
        slug:
          deprecated: true
          description: >-
            Deprecated. Use `type` instead. This field is kept for backward
            compatibility and will be removed in future versions.
          allOf:
            - $ref: '#/components/schemas/ComplianceSlug'
        schema:
          type: object
          additionalProperties: true
        missingFields:
          type: array
          items:
            type: string
        requiredDocuments:
          type: array
          items:
            $ref: '#/components/schemas/RequiredDocuments'
        requiredExtras:
          $ref: '#/components/schemas/RequiredExtras'
        type:
          allOf:
            - $ref: '#/components/schemas/ComplianceType'
      required:
        - slug
        - schema
        - missingFields
        - requiredDocuments
        - requiredExtras
        - type
    ComplianceSlug:
      type: string
      enum:
        - compliance-fee5483c
        - compliance-3d0947c0
        - compliance-9f5059c4
        - compliance-4a8e9f3b
        - compliance-7b9d2c6a
        - compliance-de8e1920
        - compliance-t7f4b831
        - compliance-h9x7p245
        - compliance-432704
        - compliance-15bc9ec4
        - compliance-a96ad46a
        - compliance-4c347d0a
        - compliance-ff6f0b66
        - compliance-bbd0abdf
        - compliance-d4a0bea2
        - compliance-ce1ef04d
        - compliance-191335b3
        - compliance-f47aa1e0
        - compliance-b92f0ad3
        - compliance-f44d3582
        - compliance-5402f18a
        - compliance-dbd2a55c
        - compliance-2c7e1a9d
        - compliance-cc0a4f2b
        - compliance-3a7e9d1f
      description: >-
        Deprecated. Use `type` instead. This field is kept for backward
        compatibility and will be removed in future versions.
    RequiredDocuments:
      type: object
      properties:
        mode:
          allOf:
            - $ref: '#/components/schemas/RequiredDocumentsMode'
        documents:
          type: array
          items:
            $ref: '#/components/schemas/IdentityDocumentType'
      required:
        - mode
        - documents
    RequiredExtras:
      type: object
      properties:
        acceptTermsOfService:
          $ref: '#/components/schemas/AcceptTermsOfService'
        yellowcardCredentials:
          $ref: '#/components/schemas/YellowcardCredentials'
        bitsoCredentials:
          $ref: '#/components/schemas/BitsoCredentials'
        hercleCredentials:
          $ref: '#/components/schemas/HercleCredentials'
        finityCredentials:
          $ref: '#/components/schemas/GeneralCredentials'
        capaCredentials:
          $ref: '#/components/schemas/GeneralCredentials'
      required:
        - acceptTermsOfService
    ComplianceType:
      type: string
      enum:
        - Bridge_base
        - Bridge_sepa
        - Koywe_base
        - Kotanipay_base
        - Bitso_base
        - Yellowcard_base
        - TraceFinance_base
        - HoneyCoin_base
        - BlindPay_base
        - BlindPay_enhanced
        - Finity_base
        - Ares_base
        - Hercle_base
        - Infinia_base
        - Walapay_base
        - Yativo_base
        - Capa_base
        - Bivo_base
        - Cobre_base
        - Brale_base
        - Juicyway_base
        - Onmeta_base
        - Onmeta_ind
        - Alfred_base
        - Demo_base
        - CrissCross_base
        - TripleA_base
    RequiredDocumentsMode:
      type: string
      enum:
        - oneOf
        - allOf
    IdentityDocumentType:
      type: string
      enum:
        - Passport
        - DriverLicense
        - NationalId
        - ResidencePermit
        - Formation
        - Ownership
        - ProofOfAddress
        - SourceOfFunds
        - IndividualHolding
        - BVN_NG
        - Selfie
        - Aadhaar
        - PAN
        - TaxId
        - LetterOfAuthority
        - EvidenceOfGoodStanding
        - ProofOfNatureOfBusiness
        - Other
    AcceptTermsOfService:
      type: object
      properties:
        link:
          type: string
        redirectUrl:
          type: string
          nullable: true
      required:
        - link
        - redirectUrl
    YellowcardCredentials:
      type: object
      properties:
        provided:
          type: boolean
        valid:
          type: boolean
      required:
        - provided
        - valid
    BitsoCredentials:
      type: object
      properties:
        provided:
          type: boolean
        valid:
          type: boolean
        status:
          $ref: '#/components/schemas/BitsoCredentialsStatus'
        verificationLevel:
          $ref: '#/components/schemas/BitsoCredentialsVerificationLevel'
      required:
        - provided
        - valid
        - status
        - verificationLevel
    HercleCredentials:
      type: object
      properties:
        provided:
          type: boolean
        valid:
          type: boolean
      required:
        - provided
        - valid
    GeneralCredentials:
      type: object
      properties:
        provided:
          type: boolean
        valid:
          type: boolean
      required:
        - provided
        - valid
    BitsoCredentialsStatus:
      type: object
      properties:
        current:
          type: string
        required:
          type: string
      required:
        - current
        - required
    BitsoCredentialsVerificationLevel:
      type: object
      properties:
        current:
          type: number
          nullable: true
        minimum:
          type: number
      required:
        - current
        - minimum
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````