API REFERENCE

Clients API

Pass custom properties through a Flow URI, then search onboarded clients by those properties and read their interaction data after the Flow completes.

Base URL · Auth · Examples

Base URL https://clients.assentify.com Auth x-api-key Scope Tenant Identifier

How it works

The Clients API lets you pass specific properties through the URI of a Flow. After a client goes through the Flow, those custom properties are saved in the interaction data and become searchable through the API. To use this feature:

Specify the custom properties in the Flow Builder JSON Viewer.
In the Clients API, generate a Flow URI that includes these properties and their respective values.
After the client completes the Flow, search for clients by the custom keys you provided.

Interactive referenceAn interactive Swagger reference is available at https://clients.assentify.com/swagger/index.html, where each endpoint can be filled in and executed.

Auth & tenant

Requests are authenticated with an x-api-key header. Client endpoints are scoped to your tenant, so most calls also take a Tenant Identifier that identifies your account within the platform.

Name	In	Type	Description
x-api-key	header	string	Your API key, used to authenticate the request.
Tenant Identifier	path	string	Identifies your tenant. Supplied on the client and search endpoints.

Define custom properties in the JSON Viewer

Custom properties are defined on the Flow itself. Once defined, any values you pass for them through the Flow URI are stored in the interaction data and become searchable keys.

Login into the Assentify Admin Portal (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 on Edit Engagement.
Click on the magnifying glass icon of the Connector Block (the JSON Viewer).
Fill in the property name.
Click on the plus button to add it (for example, My Custom Property).

Why this mattersThe property name you add here becomes the key you later search on. Define every property you plan to pass through the Flow URI before you generate it.

Generate the Flow URI

POST/api/Engagement

Generate a Flow URI that includes your custom properties and their values. The response contains the URI you send to the client.

Go to the Assentify Clients API (https://clients.assentify.com/swagger/index.html).
Under the Engagement section, click on the /api/Engagement endpoint.
Fill in the form data.
Click on Execute. The response will contain the URI.

POST /api/Engagement
Host: clients.assentify.com
x-api-key: <your-api-key>

The response contains the generated Flow URI, which embeds the custom property values you supplied.

{
  "uri": "<generated-flow-uri>"
}

Source noteThe exact request field names for this endpoint are entered through the Swagger form and are not enumerated in the source guide, so they are not listed here.

Get Single Client

GET/api/Client/{ClientIdentifier}

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

Name	In	Type	Description
ClientIdentifier	path	string	The client identifier generated by the system.
Tenant Identifier	path	string	Identifies your tenant.
x-api-key	header	string	Your API key.

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

Document	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 that 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.

Go to the Assentify Clients API (https://clients.assentify.com/swagger/index.html).
In the clients section, click on the api/Client/{ClientIdentifier} endpoint.
Fill in the Tenant Identifier and Client Identifier.
Set the Boolean filters for the client documents you want returned.

GET /api/Client/{ClientIdentifier}
Host: clients.assentify.com
x-api-key: <your-api-key>

{
  "kycDocuments": [ ... ],
  "signedDocuments": [ ... ],
  "historyOfInteractions": [ ... ],
  "additionalInformation": { ... },
  "amlScreening": { ... }
}

Source noteThe response is the client model filtered by the Boolean flags above. Individual field names within each document set are not enumerated in the source guide.

Search Client

POST/api/Client/Search/{key}

Search for a client using one of the custom keys you provided in the JSON Viewer.

Name	In	Type	Description
key	path	string	The name of the custom key you provided.
Tenant Identifier	path	string	Identifies your tenant.
x-api-key	header	string	Your API key.
search value	body	string	The value to search for on the given key.
document filters	body	boolean	Filter the returned client documents (KYC, Signed, History, Additional Information, AML Screening).

Go to the Assentify Clients API (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.

POST /api/Client/Search/{key}
Host: clients.assentify.com
x-api-key: <your-api-key>
Content-Type: application/json

{
  "searchValue": "<value-to-match>"
}

[
  {
    "clientIdentifier": "<client-identifier>",
    "additionalInformation": { "<key>": "<value-to-match>" }
  }
]

Bulk Search Clients

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

Similar to Search Client, but instead of a single search value it accepts a list of values so you can bulk search clients.

Name	In	Type	Description
key	path	string	The name of the custom key you provided.
Tenant Identifier	path	string	Identifies your tenant.
x-api-key	header	string	Your API key.
values	body	array<string>	The list of values to search for on the given key.
document filters	body	boolean	Filter the returned client documents.

Go to the Assentify Clients API (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 of this request, provide a filter for the client documents as well as the list of values.

POST /api/Client/Search/Bulk/{key}
Host: clients.assentify.com
x-api-key: <your-api-key>
Content-Type: application/json

{
  "values": [ "<value-1>", "<value-2>" ]
}

[
  {
    "clientIdentifier": "<client-identifier>",
    "additionalInformation": { "<key>": "<value-1>" }
  }
]

Get All Clients

GET/api/Client

Retrieve all the clients you currently have in the system.

Name	In	Type	Description
Tenant Identifier	path	string	Identifies your tenant.
x-api-key	header	string	Your API key.

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

GET /api/Client
Host: clients.assentify.com
x-api-key: <your-api-key>

[
  { "clientIdentifier": "<client-identifier>" }
]