Skip to main content

Request API​

The Send Request API provided by ezto verify is designed for initiating API calls that primarily purposes to trigger predefined transaction flows configured within the system.

Base URL
    base_url string required

You can get the base_url here.

Path Parameters
    workspaceName string required

You can get the workspaceName here.

Header Parameters
    Content-Type string
    Example: application/x-www-form-urlencoded
note

The request body for an application with consent enabled is displayed below.

Request Body

app_idstringRequired

It is a unique identifier that comes with every application created under ezto verify.

app_secretstringRequired

Every application comes with an application secret upon being created, that can be rotated through the application.

requestjson

This type consists of all the required data to be validated.

You can get the app_id and app_secret here.

Sample Request Body
{
  "app_id": "2ed89c16-8cab-44c6-8329-0ac856276586",
  "app_secret": "mU6yOWVP3QVzM0BFSkSL6P7gRNjeQUM40WTHrVufxHt1SByVUVJFynYNEZGzW1xT",
  "request": {
    "user": {
      "metadata": {
        "workflow":"onboarding"
      }
    },
    "message": {
      "consent": {
        "type": "json",
        "title": "Onboarding Request",
        "message": {
          "RequestFrom": "EventBeep",
          "Purpose": "Onboarding"
        }
      }
    }
  }
}
note

The request and response are different based on the application's configuration, which can be build using API Builder.

HTTP STATUS CODE SUMMARY
200 - OKEverything worked as expected.
400 - Bad RequestThe request was unacceptable, often due to missing a required parameter.
401 - UnauthorizedNo valid App secret or App ID provided.
402 - Request FailedThe parameters were valid but the request failed.
403 - ForbiddenThe Application doesn't have permissions to perform the request.
404 - Not FoundThe requested resource doesn't exist.
500 - Server ErrorsSomething went wrong on ezto verify's end. (These are rare.)
Loading...