BlendFi
APIUsersKYC

Start a KYC submission for a user

POST
/v1/users/{id}/kyc

Authorization

ApiKey
AuthorizationBearer <token>

Paste your BlendFi API key. Sandbox keys start with sk_test_. The Bearer prefix is added automatically.

In: header

Path Parameters

id*string
Formatuuid

Header Parameters

idempotency-key*string

Client-generated unique key to make the mutation safe to retry.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.sandbox.blendfi.com.br/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/kyc" \  -H "idempotency-key: 0196c5d9-2e34-7c24-a47e-a0e1f89bb8a9" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "string",
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  "provider": "string",
  "external_id": "string",
  "status": "initiated",
  "submitted_at": "2019-08-24T14:15:22Z",
  "result_at": "2019-08-24T14:15:22Z",
  "rejection_reasons": [
    {
      "code": "string",
      "category": "document",
      "message": "string",
      "retriable": true,
      "provider_code": "string"
    }
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "mode": "link",
  "verification_link": "http://example.com",
  "verification_link_expires_at": "2019-08-24T14:15:22Z",
  "refreshed": true
}

{
  "code": "idempotency_key_required",
  "message": "Idempotency-Key header is required for this method.",
  "request_id": "01KPR9F6MM8G147177J7ZQPJHG"
}

{
  "code": "authentication_required",
  "message": "No valid credentials provided.",
  "request_id": "01KPR9F6MM8G147177J7ZQPJHG"
}

{
  "code": "missing_capability",
  "message": "Your API key does not have the required capability for this endpoint.",
  "request_id": "01KPR9F6MM8G147177J7ZQPJHG"
}

{
  "code": "user_not_found",
  "message": "User not found.",
  "request_id": "01KPR9F6MM8G147177J7ZQPJHG"
}

{
  "code": "idempotency_key_reused",
  "message": "Idempotency-Key was previously used with a different request body.",
  "request_id": "01KPR9F6MM8G147177J7ZQPJHG"
}

{
  "code": "invalid_kyc_state",
  "message": "Operation not allowed in the current KYC state.",
  "request_id": "01KPR9F6MM8G147177J7ZQPJHG"
}

{
  "code": "rate_limit_exceeded",
  "message": "Too many requests. Try again after the retry_after_seconds window.",
  "request_id": "01KPR9F6MM8G147177J7ZQPJHG",
  "details": {
    "retry_after_seconds": 60
  }
}
{
  "code": "internal_error",
  "message": "Internal server error.",
  "request_id": "01KPR9F6MM8G147177J7ZQPJHG"
}
{
  "code": "kyc_provider_unavailable",
  "message": "KYC provider is temporarily unavailable.",
  "request_id": "01KPR9F6MM8G147177J7ZQPJHG"
}

Refresh a KYC SDK access token

Issues a fresh embedded-SDK access token for an in-progress KYC submission. Only available to organizations with SDK-mode KYC enabled.

Cancel a conversion before any deposit arrives

Releases the reserved limit and transitions the conversion to `canceled`. Valid only on `awaiting_deposit`.