BlendFi
API referenceTransactionsTest helpers

Force a KYC outcome for sandbox testing

Sandbox-only. Fires the Sumsub review pipeline with the provided status. Requires an existing KYC submission for the user.

POST
/v1/test_helpers/users/{id}/kyc
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

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

curl -X POST "https://api.sandbox.blendfi.com.br/v1/test_helpers/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/kyc" \  -H "Content-Type: application/json" \  -d '{    "status": "approved"  }'
{
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  "kyc_status": "not_started",
  "kyc_approved_at": "2019-08-24T14:15:22Z",
  "kyc_expires_at": "2019-08-24T14:15:22Z",
  "latest_submission": {
    "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_reason": "string",
    "created_at": "2019-08-24T14:15:22Z"
  }
}
{
  "code": "string",
  "message": "string",
  "request_id": "string",
  "details": {
    "property1": null,
    "property2": null
  }
}
{
  "code": "string",
  "message": "string",
  "request_id": "string",
  "details": {
    "property1": null,
    "property2": null
  }
}
{
  "code": "string",
  "message": "string",
  "request_id": "string",
  "details": {
    "property1": null,
    "property2": null
  }
}
{
  "code": "string",
  "message": "string",
  "request_id": "string",
  "details": {
    "property1": null,
    "property2": null
  }
}
{
  "code": "string",
  "message": "string",
  "request_id": "string",
  "details": {
    "property1": null,
    "property2": null
  }
}
{
  "code": "string",
  "message": "string",
  "request_id": "string",
  "details": {
    "property1": null,
    "property2": null
  }
}
{
  "code": "string",
  "message": "string",
  "request_id": "string",
  "details": {
    "property1": null,
    "property2": null
  }
}
{
  "code": "string",
  "message": "string",
  "request_id": "string",
  "details": {
    "property1": null,
    "property2": null
  }
}