HomeDocumentationRecipesAPI Endpoints
Log In
API Endpoints

Initialise Transaction - ID Gateway

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
Defaults to c34e260d-155d-4db9-8312-8a1fe3e1236

Is a unique ID per verification. Similar to an order_id in the payment world.

string
required
Defaults to gateway.equal.test

ID to specify the identity gateway look and feel - shared by Equal

json
required

[Deprecated] As of now, please pass empty array [] All the keys configured in the gateway are shown.

string

Only for integrator businesses - partner id which will be passed back in callback as metadata

string
business_consumer_details
array of strings

When initating a transaction you can pass details of the consumer who is supposed to go through this verification in your system. If this feature is enabled in your package, Equal will generate insight which shows the difference between each consumer_details passed by you and the details provided by consumer in Equal Gateway.

business_consumer_details
allowed_consumers
array

Allowed consumers

allowed_consumers
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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