Request and submit KYC api endpoints

[Filip-L]

KYC Portal

Endpoint: [POST] verifier/application/request_kyc

Description: The functionality enables Allocators to request their clients to undergo the KYC process.

The verifier/application/request_kyc endpoint checks, based on the query params (VerifierActionsQueryParams), the current state of the application. If the condition is met, it:

• Updates the application's state to KYC requested.
• Updates the record in the database.
• Adds a comment on relevant GitHub issue and the label to kyc requested.
• Creates a commit with the updated application state on relevant branch.

Usage Condition: To execute this endpoint, the following conditions must be met:

1. The application must be in the Submitted state.

Example KYCRequestedInfo:

{
  "github_username": "github_username",
  "repo": "repo_name",
  "owner": "owner_name",
  "id": "client_address"
}

Endpoint: [POST] application/submit_kyc

Description: The application/submit_kyc endpoint allows clients to confirm their KYC status based on the received data (SubmitKYCInfo). It validates the provided information, checks the current KYC status, and if all conditions are met it:

• Updates the application's state to Submitted.
• Updates the record in the database.
• Adds a comment on relevant GitHub issue and the label to validated.
• Creates a commit with the updated application state on relevant branch.

Usage Condition: To execute this endpoint, the following conditions must be met:

1. The message dates must be valid (the message has not expired and is not from the future).

2. The client's status must be KYCRequested.

3. The client's score must be greater than 30.

Example SubmitKYCInfo:

{
  "message": 
    "KycApproval": {
      "message": "message",
      "client_id": "client_address",
      "issued_at": "issued_date",
      "expires_at": "expiry_date",
      "allocator_repo_name": "repo_name",
      "allocator_repo_owner": "owner_name"
    },
  "signature": "client_signature",
}

Deployment Considerations:

• New environment variables:

  • KYC_URL - variable should be set to the URL of the KYC portal

  • GITCOIN_PASSPORT_DECODER - variable should be set to Optimism decoder contract address (https://docs.passport.xyz/building-with-passport/smart-contracts/contract-reference)

  • PASSPORT_VERIFIER_CHAIN_ID - variable should be set to Optimism chain ID (https://docs.optimism.io/chain/networks)

  • GITCOIN_MINIMUM_SCORE - variable should be set to a minimum acceptable score

  • RPC_URL - variable should be set to Optimism RPC URL (https://docs.optimism.io/chain/networks)