API Reference
Contact Us

Upload a document

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

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

Returns a document object.

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

Represents the request body of a document.

string
required

EntityId or alias.

file
required

Binary Document representation

string
required

Original Name of the File being uploaded

string

Mime Type of the File being uploaded

string
enum
required

Document Type (i.e. passport)

string
enum
required

Document Side (Front/Back)

Allowed:
boolean

Indicates if the document is being supplied as a PoA.

string
enum
required

Country Code

metadata
array of objects
length ≤ 20

A collection of key/value pairs. These can be used to populate additional object properties.

metadata
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.

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