Custom Integration

The following page contains description of integration where UI is generated and supported on your side.

Regardless, if you want to directly connect the verification process to your existing user interface, we have prepared additional API endpoints to help you do so.

All previous information regarding the integration process as login, callbacks, etc. remains in effect.

It is also necessary to set the header X-User-IP with the IP address of the user to whom the page will be shown. Of course, the Accept, Content-Type and Authorization headers should also be set in the same way as for other API methods.

Current Step

The first endpoint informs about the current step in the verification process and describes what to do next.

curl -u my_login "https://sandbox.authologic.com/api/conversations/{conversationId}/headless" \
-H "Accept: application/vnd.authologic.v1.1+json" \
-H 'X-User-IP: XXX.X.X.X' \
-H "Content-Type: application/vnd.authologic.v1.1+json"

In response, Authologic returns information in the following format:

{
  "component": "currentComponent",
  "next": "nextStepIdentifier",
  "args": {
    "argName": "argValue"
  }
}

Detailed description of the returned attributes:

Collecting Data And Calling The Next Step

The second endpoint is designed to trigger actions in the process based on the provided information.

curl -X POST -u my_login "https://sandbox.authologic.com/api/conversations/{conversationId}/headless/{next}" \
-H "Accept: application/vnd.authologic.v1.1+json" \
-H 'X-User-IP: XXX.X.X.X' \
-H "Content-Type: application/vnd.authologic.v1.1+json" \
-d "{"args":{...}}"

Expected payload contains only attributes required in next verification step and is very simple:

{
  "args": {
    "argName1": "arg1Value",
    "argName2": "arg2Value"
  }
}

Parameters required in this call are dependent on a specific verification process. List of parameters will be included in separate description for a given process.

In response, Authologic returns information in the following format:

1. In case request contains errors:

{
  "component": "currentComponent",
  "next": "nextStepIdentifier",
  "args": {
    "argName": "argValue"
  },
  "errors": [
    {
      "field": "argName1",
      "code": "errorCode"
    }
  ]
}

2. In case interaction with process is finished:

{
  "component": "GLOBAL/ACCEPTED"
}

Detailed description of the returned attributes:

Individual endpoint calls may require sending specific values to the process in the form of an attribute map sent in the request payload.

Assuming that you have finished interaction with the process, you should expect following response:

{
  "component": "GLOBAL/ACCEPTED"
}