Fiat

Submit KYB data

Changed on

Submits KYB verification data for the organization. Safe to call more than once: the first call creates the provider customer and later calls update it, so a partial submission can be completed incrementally.

post/v1/organizations/{organization_id}/kyb/submit

Request

  • Base URL
    https://api.privy.io
  • URL
    https://api.privy.io/v1/organizations/{organization_id}/kyb/submit
  • Auth
    HTTP basic

Path parameters

organization_idstring required

The ID of the organization.

Headers

privy-app-idstring required

ID of your Privy app.

Request body

provider'bridge' required

KYC/KYB provider identifier.

environment'production' | 'sandbox'

Provider environment (production or sandbox).

endorsementsKyxEndorsementName[]

Endorsements to request during KYB.

client_agreement_idstring

Client-side agreement ID for ToS acceptance.

Example request

{
  "endorsements": [
    "sepa"
  ],
  "data": {
    "business_type": "llc",
    "associated_persons": [
      {
        "documents": [
          {
            "purposes": [
              "proof_of_address"
            ]
          }
        ],
        "kyc_screen": {
          "result": "passed"
        },
        "ofac_screen": {
          "result": "passed"
        }
      }
    ],
    "estimated_annual_revenue_usd": "1000000_9999999",
    "source_of_funds": "sales_of_goods_and_services",
    "account_purpose": "treasury_management",
    "high_risk_activities": [
      "none_of_the_above"
    ],
    "documents": [
      {
        "purposes": [
          "business_formation"
        ]
      }
    ],
    "kyb_screen": {
      "result": "passed"
    },
    "ofac_screen": {
      "result": "passed"
    }
  }
}

Response

KYB status snapshot reflecting the submitted data.

provider'bridge' required

KYC/KYB provider identifier.

environment'production' | 'sandbox' required

Provider environment (production or sandbox).

statusstring required

KYC/KYB status for the user.

requirements_duestring[] required

Top-level items still needed (e.g. link a bank account).

future_requirements_duestring[] required

Items that will be required in the future.

Example response

{
  "status": "approved",
  "tos": {
    "status": "approved"
  },
  "endorsements": [
    {
      "name": "sepa",
      "status": "approved"
    }
  ],
  "capabilities": {
    "payin_crypto": "active",
    "payout_crypto": "active",
    "payin_fiat": "active",
    "payout_fiat": "active"
  },
  "kyb": {
    "status": "approved"
  }
}

Changes