> ## 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.

# Update verification profile

> Update a user's verification profile. Changes to verified details may require verification again. Read verification requirements to check the user's status.

Omitted fields and empty strings, objects, or arrays leave stored values unchanged. Explicit null deletes the named field. Birth and residence updates preserve omitted components and may combine component updates with deletions.

A nonempty full name replaces the complete name and requires first and last names. An omitted or null middle name clears the stored middle name. A nonempty client identifier replaces the complete identifier. Individual name and identifier components cannot otherwise be deleted.



## OpenAPI

````yaml https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json patch /v1/users/{user_id}/verifications/profile
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/profile:
    patch:
      tags:
        - Verifications
      summary: Update verification profile
      description: >-
        Update a user's verification profile. Changes to verified details may
        require verification again. Read verification requirements to check the
        user's status.


        Omitted fields and empty strings, objects, or arrays leave stored values
        unchanged. Explicit null deletes the named field. Birth and residence
        updates preserve omitted components and may combine component updates
        with deletions.


        A nonempty full name replaces the complete name and requires first and
        last names. An omitted or null middle name clears the stored middle
        name. A nonempty client identifier replaces the complete identifier.
        Individual name and identifier components cannot otherwise be deleted.
      operationId: updateVerificationProfile
      parameters:
        - $ref: '#/components/parameters/UserId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Verifications_VerificationProfileUpdate'
            examples:
              profile-update:
                summary: Update a city and delete the stored birth date
                value:
                  birth:
                    city: Berlin
                    date: null
              profile-delete:
                summary: Delete all stored nationalities
                value:
                  nationalities: null
      responses:
        '200':
          description: Profile update accepted.
          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:
                type: object
                required:
                  - data
                properties:
                  data:
                    description: Result of the profile update.
                    title: UpdateVerificationProfileData
                    type: string
                    enum:
                      - success
              examples:
                profile-updated:
                  value:
                    data: success
        '400':
          $ref: '#/components/responses/VerificationsProfileBadRequestResponse'
        '401':
          $ref: '#/components/responses/VerificationsUnauthenticatedResponse'
        '403':
          $ref: '#/components/responses/VerificationsForbiddenResponse'
        '404':
          $ref: >-
            #/components/responses/VerificationsVerificationProfileNotFoundResponse
        '429':
          $ref: '#/components/responses/VerificationsResourceExhaustedResponse'
        '500':
          $ref: '#/components/responses/VerificationsInternalResponse'
        '501':
          $ref: '#/components/responses/VerificationsUnimplementedResponse'
        '503':
          $ref: '#/components/responses/VerificationsUnavailableResponse'
        '504':
          $ref: '#/components/responses/VerificationsDeadlineExceededResponse'
      security:
        - ApiKey: []
          ApiSign: []
          ApiTimestamp: []
      x-codeSamples:
        - lang: bash
          label: curl
          source: >-
            curl -X PATCH
            "https://api.sandbox.services.payward.com/v1/users/AA45N8G4MLDYWAR7/verifications/profile"
            \
              -H "API-Key: $PWS_API_KEY" \
              -H "API-Timestamp: $PWS_API_TIMESTAMP" \
              -H "API-Sign: $PWS_API_SIGN" \
              -H "Content-Type: application/json" \
              -d '{
                "birth": {
                  "city": "Berlin",
                  "date": null
                }
              }'
components:
  parameters:
    UserId:
      name: user_id
      in: path
      required: true
      example: AA23N84GGQN4WE6I
      schema:
        $ref: '#/components/schemas/UserId'
  schemas:
    Verifications_VerificationProfileUpdate:
      description: Changes to the user's verification profile.
      type: object
      additionalProperties: false
      properties:
        full_name:
          $ref: '#/components/schemas/Verifications_VerificationProfileName'
        residence:
          $ref: '#/components/schemas/Verifications_VerificationProfileResidence'
        birth:
          $ref: '#/components/schemas/Verifications_VerificationProfileBirth'
        client_identifier:
          $ref: >-
            #/components/schemas/Verifications_VerificationProfileClientIdentifier
        phone:
          description: Contact phone number. Null deletes the stored number.
          type:
            - string
            - 'null'
          maxLength: 16
          pattern: ^(\+?[1-9][0-9]{1,14})?$
        occupation:
          description: Occupational category. Null deletes the stored occupation.
          type:
            - string
            - 'null'
          pattern: >-
            ^(agriculture|business_management|computers_and_it|construction|education|finance|government|healthcare|hospitality|manufacturing|marketing|media|other|science|self_employed|student|transportation|unemployed|employed)?$
        employer_name:
          description: Employer name. Null deletes the stored employer.
          type:
            - string
            - 'null'
          maxLength: 256
        nationalities:
          description: Replacement nationalities. Null deletes all stored nationalities.
          type:
            - array
            - 'null'
          items:
            type: string
            pattern: ^[A-Z]{2}$
        tax_ids:
          description: >-
            Replacement tax identifiers, with one identifier per issuing
            country. Null deletes all stored tax identifiers.
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/Verifications_VerificationProfileTaxId'
    UserId:
      description: Globally unique public identifier for a user.
      type: string
      minLength: 14
      maxLength: 42
    Verifications_VerificationProfileName:
      description: >-
        Complete legal name replacement. Empty objects leave the stored name
        unchanged, and null deletes it.
      type:
        - object
        - 'null'
      additionalProperties: false
      properties:
        first_name:
          description: Legal first name.
          type:
            - string
            - 'null'
          maxLength: 256
        middle_name:
          description: >-
            Legal middle name. Omission or null clears the stored middle name
            when replacing the name.
          type:
            - string
            - 'null'
          maxLength: 256
        last_name:
          description: Legal last name.
          type:
            - string
            - 'null'
          maxLength: 256
    Verifications_VerificationProfileResidence:
      description: >-
        Sparse residential address changes. Empty objects leave the address
        unchanged, and null deletes the entire address.
      type:
        - object
        - 'null'
      additionalProperties: false
      properties:
        line1:
          description: First address line. Null deletes this component.
          type:
            - string
            - 'null'
          maxLength: 256
        line2:
          description: Second address line. Null deletes this component.
          type:
            - string
            - 'null'
          maxLength: 256
        city:
          description: City of residence. Null deletes this component.
          type:
            - string
            - 'null'
          maxLength: 128
        postal_code:
          description: Postal code. Null deletes this component.
          type:
            - string
            - 'null'
          maxLength: 32
        province:
          description: State or province. Null deletes this component.
          type:
            - string
            - 'null'
          maxLength: 128
        country:
          description: Country of residence. Null deletes this component.
          type:
            - string
            - 'null'
          maxLength: 2
          pattern: ^$|^[A-Z]{2}$
    Verifications_VerificationProfileBirth:
      description: >-
        Sparse birth detail changes. Empty objects leave birth details
        unchanged, and null deletes all stored birth details.
      type:
        - object
        - 'null'
      additionalProperties: false
      properties:
        date:
          description: Date of birth. Null deletes the stored date.
          type:
            - string
            - 'null'
          pattern: ^$|^[0-9]{4}-[0-9]{2}-[0-9]{2}$
        city:
          description: City of birth. Null deletes the stored city.
          type:
            - string
            - 'null'
          maxLength: 128
        country:
          description: Country of birth. Null deletes the stored country.
          type:
            - string
            - 'null'
          maxLength: 2
          pattern: ^$|^[A-Z]{2}$
    Verifications_VerificationProfileClientIdentifier:
      description: >-
        Complete identifier replacement. `concat` requires a value and
        calculation time; passport, national ID and tax ID require a value only;
        unknown carries neither. Empty objects leave the stored identifier
        unchanged.
      type:
        - object
        - 'null'
      additionalProperties: false
      properties:
        type:
          description: Category that determines which identifier details apply.
          type:
            - string
            - 'null'
          pattern: ^(concat|passport|national_id|tax_id|unknown)?$
        value:
          description: Identifier issued to the user.
          type:
            - string
            - 'null'
          maxLength: 256
        calculated_at:
          description: Calculation time for a concatenated identifier.
          type:
            - string
            - 'null'
    Verifications_VerificationProfileTaxId:
      description: Tax identifier and its issuing jurisdiction.
      type: object
      additionalProperties: false
      required:
        - id
        - issuing_country
      properties:
        id:
          description: Identifier issued to the taxpayer.
          type: string
          minLength: 1
          maxLength: 128
        issuing_country:
          description: Country that issued the tax identifier.
          type: string
          pattern: ^[A-Z]{2}$
    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_VerificationProfileNotFoundError:
      description: The requested user's verification profile 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_profile_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
    UnimplementedError:
      description: The requested operation is not implemented.
      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: 501
                    code:
                      type: string
                      enum:
                        - unimplemented
    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
    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
    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
  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:
    VerificationsProfileBadRequestResponse:
      description: >-
        The profile update is invalid. Each cause names a rejected field and the
        reason.
      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:
            incomplete-name:
              summary: A full name without a last name
              value:
                error:
                  type: verifications_error
                  status: 400
                  instance: req_123
                  code: bad_request
                  causes:
                    - field: full_name.last_name
                      message: The last name is required to replace the full name.
            invalid-birth-date:
              summary: A birth date that doesn't exist
              value:
                error:
                  type: verifications_error
                  status: 400
                  instance: req_123
                  code: bad_request
                  causes:
                    - field: birth.date
                      message: The birth date must be a valid calendar date.
    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: >-
        The API gateway rejected the request (`gateway`), for example because
        `user_id` doesn't identify one of your users, or the service refused the
        operation (`forbidden`). Branch on `error.code`.
      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
            unknown-user:
              summary: The user ID doesn't identify one of your users
              value:
                error:
                  type: service_error
                  status: 403
                  instance: req_123
                  code: gateway
    VerificationsVerificationProfileNotFoundResponse:
      description: Verification profile 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_VerificationProfileNotFoundError
          examples:
            verification-profile-not-found:
              value:
                error:
                  type: verifications_error
                  status: 404
                  instance: req_123
                  code: verification_profile_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
    VerificationsUnimplementedResponse:
      description: Error response
      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/UnimplementedError'
          examples:
            unimplemented:
              value:
                error:
                  type: api_error
                  status: 501
                  instance: req_123
                  code: unimplemented
    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.
    ApiTimestamp:
      type: apiKey
      in: header
      name: API-Timestamp
      description: >-
        Time the request was signed, as Unix milliseconds. Included in the
        request signature. Requests signed too far from the server's time are
        rejected.

````