API REFERENCE

Flow URL and Engagement API

Generate a Digital Engagement Link programmatically. Define custom properties in the Flow Builder, pass them through the flow URI, and search clients by those properties once the flow is complete.

Base URL clients.assentify.com · Auth Tenant Identifier · Worked example

Base URL https://clients.assentify.com Swagger https://clients.assentify.com/swagger/index.html Auth Tenant Identifier

How it works

The Assentify Clients API lets you pass specific properties through the URI of a flow. Those properties travel with the Digital Engagement Link, and after the client completes the flow they are saved in the interaction data. You can then search for clients by those custom properties through the API.

Specify the custom properties in the Flow Builder JSON Viewer.
In the Clients API, generate a Flow URI that includes those properties and their respective values.
After the client goes through the flow, the custom properties are saved in the interaction data and can be used to search for clients through the API.

Properties are defined in the JSON ViewerThe source does not describe block-loader-field parameters. Custom properties are defined in the Flow Builder JSON Viewer (the magnifying-glass icon on the Connector Block), then passed to the Engagement endpoint when you generate the Flow URI.

Swagger console

Every endpoint on this page can be explored and executed from the interactive Swagger console. Use it to fill in form data, click Execute, and read the live response.

Swagger UI https://clients.assentify.com/swagger/index.html

Define custom properties in the JSON Viewer

Custom properties are declared on the flow itself before you generate any URI. You add them from the Flow Builder JSON Viewer, which opens from the magnifying-glass icon on the Connector Block.

Log in to the Assentify Admin Portal at https://admin.assentify.com.
Go to the Digital Services section.
Click on the Flow you want to add the properties to.
In the top right corner, click Edit Engagement.
Click the magnifying-glass icon on the Connector Block to open the JSON Viewer.
Fill in the property name (for example, My Custom Property).
Click the plus button to add the property.

Property names become search keysThe name you enter here is the same key you later pass to the Engagement endpoint, and the same key you use with the Search Client endpoints.

Generate the Flow URI

Use the /api/Engagement endpoint to generate a Flow URI (the Digital Engagement Link) that carries your custom properties and their values. The response contains the URI you share with the client. Run it from the Swagger console, where the exact HTTP method and fields are shown for your tenant.

/api/Engagement

Open the Assentify Clients API Swagger at https://clients.assentify.com/swagger/index.html.
Under the Engagement section, open the /api/Engagement endpoint.
Fill in the form data, including the custom property names you defined in the JSON Viewer and their values for this engagement.
Press Execute. The response contains the generated Flow URI.

Read the shape from SwaggerThe source describes generating the URI through the Swagger form and reading the URI from the response. The exact HTTP method, the full field list, and the response body are shown in the live Swagger console for your tenant, so use it as the authority rather than a fixed sample here.

Worked exampleDefine a property named My Custom Property in the JSON Viewer of the Connector Block. In Swagger, open /api/Engagement, set that property to ACC-10293, and Execute. Share the returned Flow URI with the client. Once they finish the flow, find them with the Search Client endpoint using the key My Custom Property and the value ACC-10293.

Get Single Client

Query a single client using the Client Identifier generated by our system.

GET/api/Client/{ClientIdentifier}

Name	In	Type	Description
Tenant Identifier	form data	string	Identifies your tenant.
Client Identifier	path	string	The Client Identifier generated by our system.

You can filter the client model to return only the desired client documents. The following documents are controlled by Boolean values.

Filter	Type	Description
KYC Documents	boolean	All KYC documents collected from the client (Passport, ID Card, and similar).
Signed Documents	boolean	All documents signed by the client.
History of Interactions	boolean	All the interaction history the client has completed.
Additional Information	boolean	The custom properties provided by the tenant.
AML Screening	boolean	The results of AML screening, if any matches were confirmed.

Request example

GET /api/Client/<ClientIdentifier> HTTP/1.1
Host: clients.assentify.com
Accept: application/json

Search Client

Search for a single client using the custom keys that you provided.

POST/api/Client/Search/{key}

Go to the Assentify Clients API Swagger at https://clients.assentify.com/swagger/index.html.
In the clients section, click on the /api/Client/Search/{key} endpoint.
Fill in the Tenant Identifier and the Key (the name of the custom key you provided).
In the request body, filter the client documents and provide the search value.

Name	In	Type	Description
Tenant Identifier	form data	string	Identifies your tenant.
key	path	string	The name of the custom key you provided.
Search value	body	string	The value to match for the given key.
Document filters	body	boolean	Filter which client documents are returned (see Get Single Client).

Request example

POST /api/Client/Search/My%20Custom%20Property HTTP/1.1
Host: clients.assentify.com
Content-Type: application/json

{
  "searchValue": "ACC-10293"
}

Bulk Search Clients

This request is similar to Search Client. Instead of a single search value, it accepts a list of values so that you can bulk search clients.

POST/api/Client/Search/Bulk/{key}

Go to the Assentify Clients API Swagger at https://clients.assentify.com/swagger/index.html.
In the clients section, click on the /api/Client/Search/Bulk/{key} endpoint.
Fill in the Tenant Identifier and the Key (the name of the custom key you provided).
In the body, provide a filter for the client documents and the list of values.

Name	In	Type	Description
Tenant Identifier	form data	string	Identifies your tenant.
key	path	string	The name of the custom key you provided.
Values	body	array	The list of values to match for the given key.
Document filters	body	boolean	Filter which client documents are returned (see Get Single Client).

Request example

POST /api/Client/Search/Bulk/My%20Custom%20Property HTTP/1.1
Host: clients.assentify.com
Content-Type: application/json

{
  "values": ["ACC-10293", "ACC-10294", "ACC-10295"]
}

Get All Clients

Retrieve all the clients you currently have in the system.

GET/api/Client

Go to the Assentify Clients API Swagger at https://clients.assentify.com/swagger/index.html.
In the clients section, click on the /api/Client endpoint.
Fill in the Tenant Identifier.

Name	In	Type	Description
Tenant Identifier	form data	string	Identifies your tenant.

Request example

GET /api/Client HTTP/1.1
Host: clients.assentify.com
Accept: application/json