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

# Get verification requirements

> Get the user's verification state and ordered required actions. The `user_action_required` field is true only when the user or partner can complete an action now. A `wait` action is non-actionable.



## OpenAPI

````yaml https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/users/{user_id}/verifications/requirements
openapi: 3.1.0
info:
  title: PWS Public API
  version: '1'
  description: >-
    Integrate with Payward Services to onboard users, manage accounts and funds,
    trade assets, and receive event notifications.
  contact:
    name: Payward Services
servers:
  - url: https://api.sandbox.services.payward.com
security: []
tags:
  - name: Assets
    description: List the assets PWS is willing to swap.
    x-displayName: Assets
  - name: Conversions
    description: >-
      Rule-driven and on-demand fiat ↔ crypto value movement, including
      conversion rules and deposits.
    x-displayName: Conversions
  - name: Auto Earn
    description: >-
      Manage Auto Earn preferences and retrieve allocation and reward
      information.
    x-displayName: Auto Earn
  - name: Bonded Earn
    description: >-
      Allocate funds to and deallocate funds from bonded earn strategies, review
      allocations, and track request status.
    x-displayName: Bonded Earn
  - name: Funding
    description: >-
      Discover deposit and withdrawal options, manage deposit addresses, and
      move funds between accounts.
    x-displayName: Funding
  - name: Derivative transfers
    description: >-
      Move funds between an account's spot balance and the same owner's futures
      balance.
    x-displayName: Derivative transfers
  - name: Portfolio
    description: 'Inspect a customer''s portfolio: balances, valuations, and transactions.'
    x-displayName: Portfolio
  - name: Ramp
    description: >-
      Support Ramp flows with discovery, quotes, limits, and hosted checkout
      experiences.
    x-displayName: Ramp
  - name: Reports
    description: Settlement and reconciliation reports for the partner.
    x-displayName: Reports
  - name: Swaps
    description: Account-funded quotes that lock a price until they expire or are executed.
    x-displayName: Swaps
  - name: Onchain quotes
    description: Wallet-funded quotes that return the data needed to settle onchain.
    x-displayName: Onchain quotes
  - name: Price trigger swaps
    description: Swaps that wait for a target price before submitting a trade.
    x-displayName: Price trigger swaps
  - name: Travel Rule verifications
    description: Travel Rule address ownership verification flows.
    x-displayName: Travel Rule verifications
  - name: Users
    description: >-
      User onboarding and status flows that the partner manages.


      - **Create User** provisions an account-owned user from an external
      reference and optional email.

      - **Get User** retrieves the user's profile, verification status, and
      required actions.


      Use the returned user `id` for calls that require the user's identifier.
    x-displayName: Users
  - name: Verifications
    description: Identity verification (KYC) submission and status for end users.
    x-displayName: Verifications
  - name: Webhooks
    description: >-
      Register HTTPS destinations to receive event deliveries, rotate signing
      secrets, and inspect, update, or delete existing subscriptions. Each
      subscription is owned by the authenticated partner; deliveries are signed
      with HMAC-SHA256 and retried on transient failures.
    x-displayName: Webhooks
paths:
  /v1/users/{user_id}/verifications/requirements:
    get:
      tags:
        - Verifications
      summary: Get verification requirements
      description: >-
        Get the user's verification state and ordered required actions. The
        `user_action_required` field is true only when the user or partner can
        complete an action now. A `wait` action is non-actionable.
      operationId: getVerificationRequirements
      parameters:
        - $ref: '#/components/parameters/UserId'
      responses:
        '200':
          description: Verification requirements returned.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    oneOf:
                      - $ref: >-
                          #/components/schemas/Verifications_VerificationStatusOk
                      - $ref: >-
                          #/components/schemas/Verifications_VerificationStatusDisabled
                      - $ref: >-
                          #/components/schemas/Verifications_VerificationStatusClosed
                    discriminator:
                      propertyName: state
                      mapping:
                        ok: >-
                          #/components/schemas/Verifications_VerificationStatusOk
                        disabled: >-
                          #/components/schemas/Verifications_VerificationStatusDisabled
                        closed: >-
                          #/components/schemas/Verifications_VerificationStatusClosed
                required:
                  - data
              examples:
                verification-required:
                  summary: User action is required
                  value:
                    data:
                      state: disabled
                      user_action_required: true
                      required_actions:
                        - action_type: verification
                          verification_type: identity
                          reasons:
                            - initial_onboarding
          headers:
            X-Trace-Id:
              $ref: '#/components/headers/TraceId'
            Strict-Transport-Security:
              $ref: '#/components/headers/StrictTransportSecurity'
            Cache-Control:
              $ref: '#/components/headers/CacheControl'
        '400':
          $ref: '#/components/responses/VerificationsBadRequestResponse'
        '401':
          $ref: '#/components/responses/VerificationsUnauthenticatedResponse'
        '403':
          $ref: '#/components/responses/VerificationsForbiddenResponse'
        '404':
          $ref: >-
            #/components/responses/VerificationsVerificationRequirementsNotFoundResponse
        '429':
          $ref: '#/components/responses/VerificationsResourceExhaustedResponse'
        '500':
          $ref: '#/components/responses/VerificationsInternalResponse'
        '503':
          $ref: '#/components/responses/VerificationsUnavailableResponse'
        '504':
          $ref: '#/components/responses/VerificationsDeadlineExceededResponse'
      security:
        - ApiKey: []
          ApiSign: []
          ApiNonce: []
      x-codeSamples:
        - lang: bash
          label: curl
          source: >-
            curl -X GET
            "https://api.sandbox.services.payward.com/v1/users/AA45N8G4MLDYWAR7/verifications/requirements"
            \
              -H "API-Key: $PWS_API_KEY" \
              -H "API-Nonce: $PWS_API_NONCE" \
              -H "API-Sign: $PWS_API_SIGN"
components:
  parameters:
    UserId:
      name: user_id
      in: path
      required: true
      example: AA23N84GGQN4WE6I
      schema:
        $ref: '#/components/schemas/UserId'
  schemas:
    Verifications_VerificationStatusOk:
      title: Active
      type: object
      additionalProperties: false
      description: The user is active.
      properties:
        state:
          description: Current verification state of the user.
          type: string
          enum:
            - ok
        user_action_required:
          type: boolean
          description: Whether the user or partner can complete a required action now.
        required_actions:
          type: array
          description: Ordered actions associated with the current verification state.
          items:
            $ref: '#/components/schemas/Verifications_VerificationRequiredAction'
      required:
        - state
        - user_action_required
        - required_actions
    Verifications_VerificationStatusDisabled:
      title: Disabled
      type: object
      additionalProperties: false
      description: The user is disabled.
      properties:
        state:
          description: Current verification state of the user.
          type: string
          enum:
            - disabled
        user_action_required:
          type: boolean
          description: Whether the user or partner can complete a required action now.
        required_actions:
          type: array
          description: Ordered actions associated with the current verification state.
          items:
            $ref: '#/components/schemas/Verifications_VerificationRequiredAction'
      required:
        - state
        - user_action_required
        - required_actions
    Verifications_VerificationStatusClosed:
      title: Closed
      type: object
      additionalProperties: false
      description: The user is closed.
      properties:
        state:
          description: Current verification state of the user.
          type: string
          enum:
            - closed
        user_action_required:
          type: boolean
          description: Whether the user or partner can complete a required action now.
      required:
        - state
        - user_action_required
    UserId:
      description: Globally unique public identifier for a user.
      type: string
      minLength: 14
      maxLength: 42
    Verifications_VerificationRequiredAction:
      description: Next verification-related action for the user or partner.
      oneOf:
        - $ref: '#/components/schemas/Verifications_CompleteVerificationAction'
        - $ref: '#/components/schemas/Verifications_ProvideVerificationDetailsAction'
        - $ref: '#/components/schemas/Verifications_WaitForVerificationAction'
      discriminator:
        propertyName: action_type
        mapping:
          verification: '#/components/schemas/Verifications_CompleteVerificationAction'
          provide_details: '#/components/schemas/Verifications_ProvideVerificationDetailsAction'
          wait: '#/components/schemas/Verifications_WaitForVerificationAction'
    BadRequestError:
      title: Bad Request
      description: Request validation failed or the request could not be processed.
      oneOf:
        - title: Bad Request
          allOf:
            - $ref: '#/components/schemas/PwsValidationErrorEnvelope'
            - type: object
              required:
                - error
              properties:
                error:
                  allOf:
                    - $ref: '#/components/schemas/PwsValidationError'
                    - type: object
                      required:
                        - status
                        - code
                      properties:
                        status:
                          type: integer
                          format: int32
                          const: 400
                        code:
                          type: string
                          enum:
                            - bad_request
        - title: Gateway
          description: >-
            Gateway-level validation failure returned before the request reaches
            the service.
          allOf:
            - $ref: '#/components/schemas/PwsValidationErrorEnvelope'
            - type: object
              required:
                - error
              properties:
                error:
                  allOf:
                    - $ref: '#/components/schemas/PwsValidationError'
                    - type: object
                      required:
                        - status
                        - code
                      properties:
                        type:
                          type: string
                          const: service_error
                        status:
                          type: integer
                          format: int32
                          const: 400
                        code:
                          type: string
                          const: gateway
    UnauthenticatedError:
      title: Unauthenticated
      description: Authentication credentials are missing, invalid, or not accepted.
      oneOf:
        - title: Unauthenticated
          allOf:
            - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
            - type: object
              required:
                - error
              properties:
                error:
                  allOf:
                    - $ref: '#/components/schemas/PwsGeneralError'
                    - type: object
                      required:
                        - status
                        - code
                      properties:
                        status:
                          type: integer
                          format: int32
                          const: 401
                        code:
                          type: string
                          enum:
                            - unauthenticated
        - title: Gateway
          description: Authentication failure returned by the API gateway.
          allOf:
            - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
            - type: object
              required:
                - error
              properties:
                error:
                  allOf:
                    - $ref: '#/components/schemas/PwsGeneralError'
                    - type: object
                      required:
                        - status
                        - code
                      properties:
                        type:
                          type: string
                          const: service_error
                        status:
                          type: integer
                          format: int32
                          const: 401
                        code:
                          type: string
                          const: gateway
    ForbiddenError:
      title: Forbidden
      description: The caller is not allowed to perform this operation.
      oneOf:
        - title: Forbidden
          allOf:
            - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
            - type: object
              required:
                - error
              properties:
                error:
                  allOf:
                    - $ref: '#/components/schemas/PwsGeneralError'
                    - type: object
                      required:
                        - status
                        - code
                      properties:
                        status:
                          type: integer
                          format: int32
                          const: 403
                        code:
                          type: string
                          enum:
                            - forbidden
        - title: Gateway
          description: Authorization failure returned by the API gateway.
          allOf:
            - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
            - type: object
              required:
                - error
              properties:
                error:
                  allOf:
                    - $ref: '#/components/schemas/PwsGeneralError'
                    - type: object
                      required:
                        - status
                        - code
                      properties:
                        type:
                          type: string
                          const: service_error
                        status:
                          type: integer
                          format: int32
                          const: 403
                        code:
                          type: string
                          const: gateway
    Verifications_VerificationRequirementsNotFoundError:
      description: The requested user's verification requirements do not exist.
      allOf:
        - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
        - type: object
          required:
            - error
          properties:
            error:
              allOf:
                - $ref: '#/components/schemas/PwsGeneralError'
                - type: object
                  required:
                    - status
                    - code
                  properties:
                    status:
                      type: integer
                      format: int32
                      const: 404
                    code:
                      type: string
                      enum:
                        - verification_requirements_not_found
    ResourceExhaustedError:
      description: The request was rate limited or a resource quota was exhausted.
      allOf:
        - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
        - type: object
          required:
            - error
          properties:
            error:
              allOf:
                - $ref: '#/components/schemas/PwsGeneralError'
                - type: object
                  required:
                    - status
                    - code
                  properties:
                    status:
                      type: integer
                      format: int32
                      const: 429
                    code:
                      type: string
                      enum:
                        - resource_exhausted
    InternalError:
      description: An unexpected server-side error occurred.
      allOf:
        - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
        - type: object
          required:
            - error
          properties:
            error:
              allOf:
                - $ref: '#/components/schemas/PwsGeneralError'
                - type: object
                  required:
                    - status
                    - code
                  properties:
                    status:
                      type: integer
                      format: int32
                      const: 500
                    code:
                      type: string
                      enum:
                        - internal
    UnavailableError:
      description: The service is temporarily unavailable.
      allOf:
        - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
        - type: object
          required:
            - error
          properties:
            error:
              allOf:
                - $ref: '#/components/schemas/PwsGeneralError'
                - type: object
                  required:
                    - status
                    - code
                  properties:
                    status:
                      type: integer
                      format: int32
                      const: 503
                    code:
                      type: string
                      enum:
                        - unavailable
    DeadlineExceededError:
      description: The request deadline was exceeded before a response could be produced.
      allOf:
        - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
        - type: object
          required:
            - error
          properties:
            error:
              allOf:
                - $ref: '#/components/schemas/PwsGeneralError'
                - type: object
                  required:
                    - status
                    - code
                  properties:
                    status:
                      type: integer
                      format: int32
                      const: 504
                    code:
                      type: string
                      enum:
                        - deadline_exceeded
    Verifications_CompleteVerificationAction:
      title: Complete verification
      type: object
      additionalProperties: false
      description: A verification the user must complete.
      properties:
        action_type:
          description: Discriminator identifying a verification completion action.
          type: string
          enum:
            - verification
        verification_type:
          $ref: '#/components/schemas/Verifications_RequiredVerificationType'
        reasons:
          type: array
          description: Reason codes for the required verification.
          items:
            $ref: '#/components/schemas/Verifications_RequiredVerificationReason'
        deadline:
          type: string
          format: date-time
          description: Deadline for completing the verification.
      required:
        - action_type
        - verification_type
    Verifications_ProvideVerificationDetailsAction:
      title: Provide details
      type: object
      additionalProperties: false
      description: Details the user must provide.
      properties:
        action_type:
          description: Discriminator identifying an additional-details action.
          type: string
          enum:
            - provide_details
        details_type:
          $ref: '#/components/schemas/Verifications_RequiredDetailsType'
        reason:
          $ref: '#/components/schemas/Verifications_ProvideDetailsReason'
          description: Reason code for the required details.
        deadline:
          type: string
          format: date-time
          description: Deadline for providing the details.
      required:
        - action_type
        - details_type
    Verifications_WaitForVerificationAction:
      title: Wait
      type: object
      additionalProperties: false
      description: No user or partner action is required while Payward completes a check.
      properties:
        action_type:
          description: Discriminator identifying a wait action.
          type: string
          enum:
            - wait
        wait_reason_code:
          $ref: '#/components/schemas/Verifications_WaitReason'
          description: Reason code for the wait.
      required:
        - action_type
        - wait_reason_code
    PwsValidationErrorEnvelope:
      description: Error envelope for request validation failures.
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/PwsValidationError'
          description: Validation error details.
    PwsValidationError:
      description: Standard PWS API error object for request validation failures.
      type: object
      required:
        - type
        - status
        - instance
        - code
      properties:
        type:
          description: Machine-readable error class.
          type: string
        status:
          description: HTTP status code returned for this error.
          type: integer
          format: int32
        instance:
          description: Request identifier for this specific error occurrence.
          type: string
        code:
          description: Stable machine-readable error code.
          type: string
        doc_url:
          description: Optional link to documentation for this error.
          type: string
          format: uri
        causes:
          description: Validation failures that contributed to the error.
          type: array
          items:
            $ref: '#/components/schemas/PwsErrorCause'
    PwsGeneralErrorEnvelope:
      description: Error envelope for operational or domain failures.
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/PwsGeneralError'
          description: General error details.
    PwsGeneralError:
      description: Standard PWS API error object for non-validation failures.
      allOf:
        - $ref: '#/components/schemas/PwsErrorBase'
        - type: object
          properties:
            causes:
              description: Additional error details, when present.
              type: array
              items:
                type: object
                additionalProperties: true
    Verifications_RequiredVerificationType:
      type: string
      description: Stable reference for the next verification flow.
      enum:
        - identity
        - residence
        - selfie
        - sanctions_check
        - pep_check
        - negative_news_check
        - tax_id
        - proof_of_source_of_funds
        - proof_of_source_of_wealth
    Verifications_RequiredVerificationReason:
      type: string
      description: Reason that a verification is required.
      enum:
        - initial_onboarding
    Verifications_RequiredDetailsType:
      description: Details the user or partner must provide.
      oneOf:
        - $ref: '#/components/schemas/Verifications_TermsOfServiceRequiredDetails'
        - $ref: '#/components/schemas/Verifications_FullNameRequiredDetails'
        - $ref: '#/components/schemas/Verifications_DateOfBirthRequiredDetails'
        - $ref: '#/components/schemas/Verifications_CityOfBirthRequiredDetails'
        - $ref: '#/components/schemas/Verifications_CountryOfBirthRequiredDetails'
        - $ref: '#/components/schemas/Verifications_NationalitiesRequiredDetails'
        - $ref: '#/components/schemas/Verifications_ResidenceRequiredDetails'
        - $ref: '#/components/schemas/Verifications_PhoneRequiredDetails'
        - $ref: '#/components/schemas/Verifications_OccupationRequiredDetails'
        - $ref: '#/components/schemas/Verifications_TaxIdsRequiredDetails'
        - $ref: '#/components/schemas/Verifications_EmployerRequiredDetails'
        - $ref: '#/components/schemas/Verifications_ClientIdentifierRequiredDetails'
        - $ref: '#/components/schemas/Verifications_GreekDssInvestorIdRequiredDetails'
        - $ref: '#/components/schemas/Verifications_SourceOfFundsRequiredDetails'
        - $ref: '#/components/schemas/Verifications_SourceOfWealthRequiredDetails'
      discriminator:
        propertyName: type
        mapping:
          terms_of_service: '#/components/schemas/Verifications_TermsOfServiceRequiredDetails'
          full_name: '#/components/schemas/Verifications_FullNameRequiredDetails'
          date_of_birth: '#/components/schemas/Verifications_DateOfBirthRequiredDetails'
          city_of_birth: '#/components/schemas/Verifications_CityOfBirthRequiredDetails'
          country_of_birth: '#/components/schemas/Verifications_CountryOfBirthRequiredDetails'
          nationalities: '#/components/schemas/Verifications_NationalitiesRequiredDetails'
          residence: '#/components/schemas/Verifications_ResidenceRequiredDetails'
          phone: '#/components/schemas/Verifications_PhoneRequiredDetails'
          occupation: '#/components/schemas/Verifications_OccupationRequiredDetails'
          tax_ids: '#/components/schemas/Verifications_TaxIdsRequiredDetails'
          employer: '#/components/schemas/Verifications_EmployerRequiredDetails'
          client_identifier: '#/components/schemas/Verifications_ClientIdentifierRequiredDetails'
          greek_dss_investor_id: '#/components/schemas/Verifications_GreekDssInvestorIdRequiredDetails'
          source_of_funds: '#/components/schemas/Verifications_SourceOfFundsRequiredDetails'
          source_of_wealth: '#/components/schemas/Verifications_SourceOfWealthRequiredDetails'
    Verifications_ProvideDetailsReason:
      type: string
      description: Reason that additional details are required.
      enum:
        - initial_onboarding
    Verifications_WaitReason:
      type: string
      description: Reason that no user or partner action is currently required.
      enum:
        - processing
        - pending
        - blocked
    PwsErrorCause:
      description: A single request validation failure.
      type: object
      required:
        - field
        - message
      properties:
        field:
          description: Dot-notation path to the offending request field.
          type: string
        message:
          description: Human-readable explanation of the failed validation rule.
          type: string
    PwsErrorBase:
      description: Common fields present on every PWS API error object.
      type: object
      required:
        - type
        - status
        - instance
        - code
      properties:
        type:
          description: Machine-readable error class.
          type: string
        status:
          description: HTTP status code returned for this error.
          type: integer
          format: int32
        instance:
          description: Request identifier for this specific error occurrence.
          type: string
        code:
          description: Stable machine-readable error code.
          type: string
        doc_url:
          description: Optional link to documentation for this error.
          type: string
          format: uri
    Verifications_TermsOfServiceRequiredDetails:
      title: Terms of service
      type: object
      additionalProperties: false
      description: Terms of service that the user must accept.
      properties:
        type:
          description: Discriminator identifying terms-of-service details.
          type: string
          enum:
            - terms_of_service
        version:
          type: integer
          format: int32
          minimum: 1
          description: Required terms of service version.
      required:
        - type
        - version
    Verifications_FullNameRequiredDetails:
      title: Full name
      description: Indicates that the user's full name must be provided.
      type: object
      additionalProperties: false
      properties:
        type:
          description: Discriminator identifying full-name details.
          type: string
          enum:
            - full_name
      required:
        - type
    Verifications_DateOfBirthRequiredDetails:
      title: Date of birth
      description: Indicates that the user's date of birth must be provided.
      type: object
      additionalProperties: false
      properties:
        type:
          description: Discriminator identifying date-of-birth details.
          type: string
          enum:
            - date_of_birth
      required:
        - type
    Verifications_CityOfBirthRequiredDetails:
      title: City of birth
      description: Indicates that the user's city of birth must be provided.
      type: object
      additionalProperties: false
      properties:
        type:
          description: Discriminator identifying city-of-birth details.
          type: string
          enum:
            - city_of_birth
      required:
        - type
    Verifications_CountryOfBirthRequiredDetails:
      title: Country of birth
      description: Indicates that the user's country of birth must be provided.
      type: object
      additionalProperties: false
      properties:
        type:
          description: Discriminator identifying country-of-birth details.
          type: string
          enum:
            - country_of_birth
      required:
        - type
    Verifications_NationalitiesRequiredDetails:
      title: Nationalities
      description: Indicates that the user's nationalities must be provided.
      type: object
      additionalProperties: false
      properties:
        type:
          description: Discriminator identifying nationality details.
          type: string
          enum:
            - nationalities
      required:
        - type
    Verifications_ResidenceRequiredDetails:
      title: Residence
      description: Indicates that the user's residence details must be provided.
      type: object
      additionalProperties: false
      properties:
        type:
          description: Discriminator identifying residence details.
          type: string
          enum:
            - residence
      required:
        - type
    Verifications_PhoneRequiredDetails:
      title: Phone
      description: Indicates that the user's phone number must be provided.
      type: object
      additionalProperties: false
      properties:
        type:
          description: Discriminator identifying phone details.
          type: string
          enum:
            - phone
      required:
        - type
    Verifications_OccupationRequiredDetails:
      title: Occupation
      description: Indicates that the user's occupation must be provided.
      type: object
      additionalProperties: false
      properties:
        type:
          description: Discriminator identifying occupation details.
          type: string
          enum:
            - occupation
      required:
        - type
    Verifications_TaxIdsRequiredDetails:
      title: Tax IDs
      description: Indicates that the user's tax identifiers must be provided.
      type: object
      additionalProperties: false
      properties:
        type:
          description: Discriminator identifying tax-identifier details.
          type: string
          enum:
            - tax_ids
      required:
        - type
    Verifications_EmployerRequiredDetails:
      title: Employer
      description: Indicates that the user's employer must be provided.
      type: object
      additionalProperties: false
      properties:
        type:
          description: Discriminator identifying employer details.
          type: string
          enum:
            - employer
      required:
        - type
    Verifications_ClientIdentifierRequiredDetails:
      title: Client identifier
      description: Indicates that the user's client identifier must be provided.
      type: object
      additionalProperties: false
      properties:
        type:
          description: Discriminator identifying client-identifier details.
          type: string
          enum:
            - client_identifier
      required:
        - type
    Verifications_GreekDssInvestorIdRequiredDetails:
      title: Greek DSS investor ID
      description: Indicates that the user's Greek DSS investor ID must be provided.
      type: object
      additionalProperties: false
      properties:
        type:
          description: Discriminator identifying Greek DSS investor ID details.
          type: string
          enum:
            - greek_dss_investor_id
      required:
        - type
    Verifications_SourceOfFundsRequiredDetails:
      title: Source of funds
      description: Indicates that the user's source of funds declaration must be provided.
      type: object
      additionalProperties: false
      properties:
        type:
          description: Discriminator identifying source of funds details.
          type: string
          enum:
            - source_of_funds
      required:
        - type
    Verifications_SourceOfWealthRequiredDetails:
      title: Source of wealth
      description: Indicates that the user's source of wealth declaration must be provided.
      type: object
      additionalProperties: false
      properties:
        type:
          description: Discriminator identifying source of wealth details.
          type: string
          enum:
            - source_of_wealth
      required:
        - type
  headers:
    TraceId:
      description: Trace identifier for the request. Include it when contacting support.
      schema:
        type: string
        example: 4bf92f3577b34da6a3ce929d0e0e4736
    StrictTransportSecurity:
      description: Enforces HTTPS for the duration specified by `max-age`.
      schema:
        type: string
        example: max-age=31536000; includeSubDomains; preload
    CacheControl:
      description: Prevents caching of sensitive financial data. Always `no-store`.
      schema:
        type: string
        enum:
          - no-store
        example: no-store
  responses:
    VerificationsBadRequestResponse:
      description: Validation error
      headers:
        X-Trace-Id:
          $ref: '#/components/headers/TraceId'
        Strict-Transport-Security:
          $ref: '#/components/headers/StrictTransportSecurity'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BadRequestError'
          examples:
            bad-request:
              value:
                error:
                  type: validation_error
                  status: 400
                  instance: req_123
                  code: bad_request
    VerificationsUnauthenticatedResponse:
      description: Authentication required
      headers:
        X-Trace-Id:
          $ref: '#/components/headers/TraceId'
        Strict-Transport-Security:
          $ref: '#/components/headers/StrictTransportSecurity'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UnauthenticatedError'
          examples:
            unauthenticated:
              value:
                error:
                  type: authentication_error
                  status: 401
                  instance: req_123
                  code: unauthenticated
    VerificationsForbiddenResponse:
      description: Forbidden
      headers:
        X-Trace-Id:
          $ref: '#/components/headers/TraceId'
        Strict-Transport-Security:
          $ref: '#/components/headers/StrictTransportSecurity'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ForbiddenError'
          examples:
            forbidden:
              value:
                error:
                  type: authorization_error
                  status: 403
                  instance: req_123
                  code: forbidden
    VerificationsVerificationRequirementsNotFoundResponse:
      description: Verification requirements not found
      headers:
        X-Trace-Id:
          $ref: '#/components/headers/TraceId'
        Strict-Transport-Security:
          $ref: '#/components/headers/StrictTransportSecurity'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: >-
              #/components/schemas/Verifications_VerificationRequirementsNotFoundError
          examples:
            verification-requirements-not-found:
              value:
                error:
                  type: verifications_error
                  status: 404
                  instance: req_123
                  code: verification_requirements_not_found
    VerificationsResourceExhaustedResponse:
      description: Rate limit exceeded
      headers:
        X-Trace-Id:
          $ref: '#/components/headers/TraceId'
        Strict-Transport-Security:
          $ref: '#/components/headers/StrictTransportSecurity'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResourceExhaustedError'
          examples:
            resource-exhausted:
              value:
                error:
                  type: rate_limit_error
                  status: 429
                  instance: req_123
                  code: resource_exhausted
    VerificationsInternalResponse:
      description: Internal server error
      headers:
        X-Trace-Id:
          $ref: '#/components/headers/TraceId'
        Strict-Transport-Security:
          $ref: '#/components/headers/StrictTransportSecurity'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/InternalError'
          examples:
            internal-error:
              value:
                error:
                  type: internal_error
                  status: 500
                  instance: req_123
                  code: internal
    VerificationsUnavailableResponse:
      description: Service unavailable
      headers:
        X-Trace-Id:
          $ref: '#/components/headers/TraceId'
        Strict-Transport-Security:
          $ref: '#/components/headers/StrictTransportSecurity'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UnavailableError'
          examples:
            unavailable:
              value:
                error:
                  type: service_error
                  status: 503
                  instance: req_123
                  code: unavailable
    VerificationsDeadlineExceededResponse:
      description: Deadline exceeded
      headers:
        X-Trace-Id:
          $ref: '#/components/headers/TraceId'
        Strict-Transport-Security:
          $ref: '#/components/headers/StrictTransportSecurity'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DeadlineExceededError'
          examples:
            deadline-exceeded:
              value:
                error:
                  type: service_error
                  status: 504
                  instance: req_123
                  code: deadline_exceeded
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: API-Key
      description: Your public API key. Identifies the partner making the request.
    ApiSign:
      type: apiKey
      in: header
      name: API-Sign
      description: HMAC signature over the request, computed with your private key.
    ApiNonce:
      type: apiKey
      in: header
      name: API-Nonce
      description: Monotonically increasing nonce included in the request signature.

````