Gnosis Pay KYC API

openapi: 3.2.0
info:
  title: User Service KYC API
  version: 0.0.0
servers:
- url: https://core.prod.gnosispay.com/user-api
  description: Production
  variables: {}
- url: https://core.sandbox.gnosispay.in/user-api
  description: Sandbox
  variables: {}
tags:
- name: KYC
paths:
  /kyc/import-partner-applicant:
    post:
      operationId: KYC_importPartnerApplicant
      summary: Generate KYC Applicant Share Token
      description: 'Generate a temporary Sumsub share token for the authenticated user''s KYC

        applicant. Pass the token to the named Sumsub recipient to reuse the

        applicant''s verified identity data.'
      parameters: []
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportPartnerApplicantResponse'
        '400':
          description: The server could not understand the request due to invalid syntax.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthBadRequest'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '422':
          description: Client error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportPartnerApplicantUnprocessableEntity'
        '502':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportPartnerApplicantBadGateway'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - KYC
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportPartnerApplicantRequest'
      security:
      - BearerAuth: []
      x-ogen-operation-group: KYC
components:
  schemas:
    NotFound:
      type: object
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          enum:
          - false
        error:
          type: string
    ValidationErrorDetail:
      type: object
      required:
      - name
      - message
      properties:
        name:
          type: string
          enum:
          - ValidationError
        message:
          type: string
    ImportPartnerApplicantUnprocessableEntity:
      type: object
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          enum:
          - false
        error:
          type: string
    AuthBadRequest:
      type: object
      oneOf:
      - $ref: '#/components/schemas/AuthValidationError'
      - $ref: '#/components/schemas/AuthBusinessError'
      discriminator:
        propertyName: kind
        mapping:
          validation: '#/components/schemas/AuthValidationError'
          business: '#/components/schemas/AuthBusinessError'
      description: 'Discriminated 400 body for auth POST routes. The `kind` field is additive

        and not a breaking change. Clients can keep reading `success` and `error`.'
    Error:
      type: object
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          enum:
          - false
        error:
          type: string
    ImportPartnerApplicantBadGateway:
      type: object
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          enum:
          - false
        error:
          type: string
    Unauthorized:
      type: object
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          enum:
          - false
        error:
          type: string
    ImportPartnerApplicantResponse:
      type: object
      required:
      - token
      - forClientId
      properties:
        token:
          type: string
          description: Opaque, single-use Sumsub share token.
        forClientId:
          type: string
          description: Recipient client ID confirmed by Sumsub.
    AuthValidationError:
      type: object
      required:
      - kind
      - success
      - error
      properties:
        kind:
          type: string
          enum:
          - validation
        success:
          type: boolean
          enum:
          - false
        error:
          $ref: '#/components/schemas/ValidationErrorDetail'
      description: Validation failure on auth routes (decoder / request constraints).
    AuthBusinessError:
      type: object
      required:
      - kind
      - success
      - error
      properties:
        kind:
          type: string
          enum:
          - business
        success:
          type: boolean
          enum:
          - false
        error:
          type: string
      description: Domain/business failure on auth routes (returned by handlers).
    ImportPartnerApplicantRequest:
      type: object
      required:
      - forClientId
      properties:
        forClientId:
          type: string
          minLength: 1
          description: Sumsub client ID of the recipient configured to receive applicant data.
        ttlInSecs:
          type: integer
          format: int32
          minimum: 1
          description: 'Share-token lifespan in seconds. When omitted, Sumsub''s default of 1200

            seconds applies.'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: Bearer