API Reference
Contact Us

Create a Check

post
https://localhost/KYCKnowYourCustomer/1.0/kyc/checks

With a valid object representation, this endpoint allows you to create a new check for a specific entity.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Represents the request body of a check.

string
required

ID of the entity the check was requested for.

boolean
required

User consent to any specific privacy policy

requiredReports
array of objects
required

An array of required Reports and source documents to be used.

requiredReports*
Headers
date-time

Header parameter that indicates date and time when the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.

string

Header parameter to uniquely identify the request. Must be supplied as an UUID.

string

It's used to send the pre-shared client's API key to the server.

string
required

It's used to send the user’s access token when OAuth 2.0/OIDC authorization framework is used for end-user authentication.

string
length ≤ 256

String containing the channel used to originate the request. For example USSD, Web, App.

uri

URL supplied by the client that will be used to return the callback in the form of an HTTP PUT.

Responses

Updated 7 months ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago