Spliceforms Consents API

openapi: 3.2.0
info:
  version: '1.0'
  title: Data Services Consents API
  summary: ''
  description: List of endpoints to serve the public data that may be needed for application form data capture.
  contact:
    name: akhilesh
    url: https://spliceforms.com/
    email: api@apibanking.com
  license:
    url: https://spliceforms.com/
    name: Commercial
servers:
- url: https://api.stitch.spliceforms.com/data
tags:
- name: Consents
  description: Endpoints dealing with consent management and definitions.
paths:
  /v1/consent-definitions:
    parameters: []
    get:
      summary: Fetch Consent Definitions
      description: List all the consent definitions.
      operationId: fetchConsentDefinitions
      parameters:
      - schema:
          type: integer
          default: 1
          example: 1
          minimum: 1
          maximum: 10000
          format: int32
        in: query
        name: pageNo
        description: It specifies the page number of the results to be returned
        required: true
      - schema:
          type: integer
          default: 10
          example: 10
          minimum: 1
          maximum: 100
          format: int32
        in: query
        name: pageSize
        description: It determines the number of records to be returned per page
        required: true
      responses:
        '200':
          description: This status code indicates that the request was received, understood, and processed successfully by the server. The response body will contain the data requested by the client.
          content:
            application/json:
              schema:
                allOf:
                - x-stoplight:
                    id: 64zkwtudr0zmd
                  $ref: '#/components/schemas/PaginatedResponse'
                - type: object
                  properties:
                    data:
                      type: array
                      description: List of consent definitions
                      items:
                        x-stoplight:
                          id: urn0x1tc9ajlj
                        $ref: '#/components/schemas/ConsentDefinition'
              examples: {}
        '400':
          description: This status code indicates that the server could not understand or process the request due to invalid syntax or parameters. The client should modify the request and retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
              examples:
                Example 1:
                  value:
                    type: http://example.com
                    title: string
                    status: 400
                    detail: string
                    instance: http://example.com
                    validationErrors:
                    - message: string
                      properties:
                      - string
                      severity: ERROR
        '500':
          description: This status code means the server ran into an unexpected problem while processing your request. It indicates an issue on the server side, not with your input. Try refreshing or resubmitting your request after a short wait.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
              examples:
                Example 1:
                  value:
                    type: http://example.com
                    title: string
                    status: 500
                    detail: string
                    instance: http://example.com
      x-stoplight:
        id: zct2cw8kb7tl9
      tags:
      - Consents
components:
  schemas:
    ProblemJson:
      type: object
      x-stoplight:
        id: oooamay5pgk0b
      title: ProblemJson
      description: Problem Error Json
      required:
      - title
      - status
      properties:
        title:
          type: string
          description: A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
          pattern: ^[A-Za-z0-9-_]+
          minLength: 2
          maxLength: 50
          examples:
          - Unauthorized
          x-stoplight:
            id: qp048dxgamcyv
        status:
          type: integer
          description: The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
          format: int32
          minimum: 1
          maximum: 1000
          examples:
          - 200
          x-stoplight:
            id: mppplj2ikgpo5
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem.
          pattern: ^[A-Za-z0-9-_ ]+
          minLength: 5
          maxLength: 2043
          examples:
          - api_key missing
          x-stoplight:
            id: 05ie4179zj1s5
        instance:
          type: string
          description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
          format: uri
          pattern: ^(https?|http):\/\/[^\s/$.?#].[^\s]*$
          minLength: 5
          maxLength: 2083
          examples:
          - https://example.com/resource
          x-stoplight:
            id: f0d9smdiysl1b
        validationErrors:
          type: array
          description: Validation Errors
          items:
            x-stoplight:
              id: 7vcjnrvdy7wos
            $ref: '#/components/schemas/ValidationError'
          x-stoplight:
            id: uxclbrhmspafm
    PaginatedResponse:
      type: object
      x-stoplight:
        id: cd03j7c25sy2q
      title: PaginatedResponse
      required:
      - totalRecords
      - totalPages
      - pageNo
      - pageSize
      properties:
        totalRecords:
          type: integer
          description: Total number of records available.
          format: int32
          example: 45
          minimum: 1
          maximum: 10000
          x-stoplight:
            id: ng7t6wdgbqolv
        totalPages:
          type: integer
          description: Total number of pages.
          example: 4
          minimum: 1
          maximum: 1000
          format: int32
          x-stoplight:
            id: tnb60gemsmgcg
        pageNo:
          type: integer
          description: Current page number.
          example: 2
          minimum: 1
          maximum: 100
          format: int32
          x-stoplight:
            id: 2lvw64mf3ljcq
        pageSize:
          type: integer
          description: Number of records per page.
          example: 10
          minimum: 1
          maximum: 100
          format: int32
          x-stoplight:
            id: lswzbcgxb87ul
    ValidationError:
      type: object
      x-stoplight:
        id: i03w36ken44hv
      title: ValidationError
      description: Validation Error
      required:
      - message
      - severity
      properties:
        message:
          type: string
          description: Message for the validation error
          pattern: ^[A-Za-z0-9-_ ]+
          minLength: 2
          maxLength: 2048
          examples:
          - fields can not be empty
          x-stoplight:
            id: vfc11e0vv4ka0
        fields:
          type: array
          description: One or more properties on which the validation was performed.
          items:
            type: string
            description: Propertie on which the validation was performed.
            pattern: ^[A-Za-z0-9-_]+
            minLength: 2
            maxLength: 50
            examples:
            - '23212322'
            x-stoplight:
              id: 7ezn2bw6cptug
          x-stoplight:
            id: ngstgikrr1jga
        severity:
          type: string
          enum:
          - ERROR
          - WARNING
          description: Severity of the validation error.
          pattern: ^[A-Z]+(_[A-Z]+)*$
          minLength: 2
          maxLength: 50
          examples:
          - ERROR
          x-stoplight:
            id: kcvbyilxmlci5
    ConsentDefinition:
      type: object
      x-stoplight:
        id: 4i96ikl8k2mrf
      title: ConsentDefinition
      description: It represents the structure of customer consent
      required:
      - consentId
      - consentText
      - purpose
      properties:
        consentId:
          type: integer
          x-stoplight:
            id: zw7uzhi7ibo4t
          example: 1
          format: int32
          minimum: 1
          maximum: 10000
          description: A unique identifier assigned to a consent request.
        version:
          type: string
          description: Version of the consent
          pattern: ^\d+(\.\d+)*$
          minLength: 1
          maxLength: 10
          examples:
          - 3.4.1
          x-stoplight:
            id: 4a4nfarsk6roe
        consentText:
          type: string
          pattern: ^[a-zA-Z0-9.,'"()&\-\[\]\s\/]{10,500}$
          minLength: 5
          maxLength: 500
          examples:
          - I have read the information above and have had an opportunity to ask questions about the [research / activity] and how my information will be used. I understand the purpose of the [research /activity] and what my participation involves.
          x-stoplight:
            id: c1df2li2vle9m
          description: A detailed statement that defines the terms of the consent
        purpose:
          type: array
          x-stoplight:
            id: yzzamluoghi2r
          description: List of applicable purpose codes for the consent definition
          items:
            x-stoplight:
              id: jvrysdu3j9nwi
            type: string
            pattern: ^[A-Za-z0-9 .:]+$
            minLength: 1
            maxLength: 10
            examples:
            - KYC
x-stoplight:
  id: p2yovmp4rufcv
x-internal: true
x-source: https://github.com/spliceforms/stoplight-projects/blob/main/stitch-capture-services/data-services-v1.0.yaml
x-bundled-from: openapi/_original/stitch-capture-services/data-services-v1.0.yaml (./models refs inlined into components/schemas; stoplight:// platform overrides are not resolvable outside Stoplight and are kept as x-unresolved-stoplight-ref)