API Reference
Contact Us

Creating a new Entity.

post
https://gateway-am.apps.ins.inswhub.com/entities/1.2/entities

This method allows to create a new Entity in a given tenant (which will be obtained from the token). The body contains basic data (such as name and contact information) and credentials to get tokens from the tenant ('user' attribute).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
users
array of objects
users
name
object
required
contact
object
beneficiaries
array of objects
beneficiaries
idDocuments
array of objects
idDocuments
date
string
enum
string
enum
string
enum
string
string
enum
Allowed:
entityProfileData
array of objects
entityProfileData
metadata
array of objects
metadata
string
enum
required
Allowed:
string
Headers
date-time

Header parameter that informs the date and time when the message was originated. It is used for basic message integrity checks, to ensure that 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 identifies the request. Must be supplied as an UUID.

string
length ≤ 256

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

string

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

string
required

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

uri

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

Responses

Updated 4 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 4 months ago