Fiat

Get a KYC link for a user

Changed on

Returns a KYC link for a user

post/v1/users/{user_id}/fiat/kyc_link

Request

  • Base URL
    https://api.privy.io
  • URL
    https://api.privy.io/v1/users/{user_id}/fiat/kyc_link
  • Auth
    HTTP basic

Path parameters

user_idstring required

The ID of the user

Headers

privy-app-idstring required

ID of your Privy app.

Request body

provider'bridge' | 'bridge-sandbox' required

Valid set of onramp providers

full_namestring
emailstring email required
type'individual' | 'business'
endorsementsstring[]
redirect_uristring

Example request

{
  "provider": "bridge"
}

Response

KYC link for the user

idstring required
customer_idstring required
full_namestring required
emailstring required
kyc_linkstring required
kyc_statusstring required

KYC status reported by Bridge. Passed through as a string so new Bridge statuses remain representable.

tos_linkstring required
tos_status'pending' | 'approved' required
persona_inquiry_typestring
created_atstring required

Changes

  • 4facbfa7f9d4Revision changes
    • info

      removed the approved enum value from the response property for the response status

    • info

      removed the awaiting_ubo enum value from the response property for the response status

    • info

      removed the incomplete enum value from the response property for the response status

    • info

      removed the manual_review enum value from the response property for the response status

    • info

      removed the not_started enum value from the response property for the response status

    • info

      removed the pending enum value from the response property for the response status

    • info

      removed the rejected enum value from the response property for the response status

    • info

      removed the under_review enum value from the response property for the response status