tribute-kyc-api-spec.yaml

openapi: 3.0.3
info:
  title: Tribute KYC API
  version: '1.0'
  x-logo:
    url: ''
  description: A minimal API spec to provide KYC certificates for Tribute DAO UI project.
paths:
  /kyc-certificate/{{daoRegistryContractAddress}}/{{ethereumAddress}}:
    description: >-
      The KYC certificate contains 3 main attributes: entityType, isWhitelisted,
      signature.

      A returned signature denotes that the user is kyc verified, this is
      mandatory. Your check, can be combined with isWhitelisted to only allow
      authorised users to join the DAO.
    summary: Returns the KYC certificate based on the DAO address and member address
    get:
      tags: []
      operationId: get-kyc-certificate
      summary: >-
        Retrieves the KYC certificate of a new DAO member based on the DAO
        registry and member address
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                enum:
                  - person
                  - company
                  - trust
                required:
                  - entityType
                  - isWhitelisted
                  - signature
                properties:
                  entityType: person
                  isWhitelisted: true
                  signature: >-
                    0x033a35564f3400991c2cd7e058674f1afd77d9bbbbf0cf343a5924751b2dea786c6d74ef467e304ad8fba6e76a4797cc868bd1c94e9fe65a7a6f0469ad360a881b
                description: ''
                example: ''
                externalDocs:
                  url: ''
                  description: ''
              encoding: ''
              example: ''
          x-last-modified: 1648044024185
          headers: {}
          links: {}
      description: >-
        The signature must be submitted to the KYC onboarding adapter for
        validation. If the signature is valid, the KYCed account gets added to
        the DAO as a new member.
    x-last-modified: 1648044177663
    parameters:
      - name: daoRegistryContractAddress
        in: path
        required: true
        deprecated: false
        x-last-modified: 1648043834389
      - name: ethereumAddress
        in: path
        required: true
        deprecated: false
        x-last-modified: 1648043860145
components:
  securitySchemes: {}
  schemas: {}
  headers: {}
  responses:
    '200':
      description: Operation succeeded
      x-last-modified: 1648043894433
  parameters: {}
tags: []
servers:
  - url: https://api.tribute-kyc.io
    description: ''
    variables: {}
    x-last-modified: 1648043651396
security: []