Skip to main content
POST
/
api
/
v1
/
end-users
/
{end_user_id}
/
kyc
Create KYC Submission
curl --request POST \
  --url https://sandbox-b2b.ripio.com/api/v1/end-users/{end_user_id}/kyc \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]"
}
'
{
  "submission_id": "945dfedc-ad7f-4af7-b20c-06082ffa3cb3",
  "status": "COMPLETED",
  "provider_url": "http://example.com",
  "created_at": "2019-08-24T14:15:22Z"
}

Authorizations

​
Authorization
string
header
required

B2B’s White Label API uses OAuth2. Currently there is only one supported authentication flow:

  • clientCredentials allows you to access your own B2B account (First-Party Integration) and performs transactions against the public API. This oauth2 flow is well suited for this API, as it allows machine-to-machine communication.

Every call to the API has to be authenticated with an OAuth2 Token. In order to request this token, you will need to have sandbox or production API Keys (client id and client secret) that will be needed to generate a credential in order to negotiate an ephemeral access token.

Every request must be accompianed by an Authorization header with a value that follows the following schema: Bearer ACCESS_TOKEN

Path Parameters

​
end_user_id
string
required

Body

application/json
​
email
string

End User's unique email.

​
kyc_submission
object

Json formatted data with the information detailed on KYC Requirements

Response

201 - application/json

Created

​
submission_id
string<uuid>

KYC Submission unique identifier

​
status
enum<string>

KYC Submission status.

Available options:
COMPLETED,
IN_REVIEW,
FAILED,
UPDATE_REQUIRED
​
provider_url
string | null

URL to redirect users in order for them upload or fulfill extra information. E.g: ID photo, proof of life, etc. May be null if no further information is required.

​
created_at
string<date-time>

ISO format creation datetime