API referenceUsersKYC
Start a KYC submission for a user
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
Format
uuidHeader Parameters
idempotency-key*string
Client-generated unique key to make the mutation safe to retry.
Length
1 <= lengthRequest 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/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_reason": "string",
"created_at": "2019-08-24T14:15:22Z",
"verification_link": "http://example.com",
"verification_link_expires_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
}
}