Developers · Getting Started Developer
API REFERENCE

Getting Started with the Assentify DXP APIs

Integrate with the Digital Experience Platform (DXP) over plain HTTP and JSON. Authenticate with an API key and a Tenant Identifier, then call the service you need: Clients, Submission, Sanctions Search, RTRA, Signature Integration, or the Cognitive Services Pipeline.

Base URL · Auth · Examples
Auth x-api-key header Tenant Tenant Identifier Reference Swagger

Overview

The Assentify DXP developer APIs let you run platform processes server to server, without the web UI. Across every service the integration basics are the same: you present an API key in a request header, and you identify your organization with a Tenant Identifier. Each service has its own base URL. The sections below cover authentication, where to obtain your credentials, the interactive Swagger reference, and a table linking each API page.

Two things you always needAn API key and a Tenant Identifier. The Sanctions Search API lists both as required, and the same pair is used by the Clients, Submission, RTRA, and Signature Integration services.

Authentication

Requests are authenticated with an API key sent in a request header. The header name depends on the service:

ServiceHeaderNotes
Submission APIx-api-keyThe API key must possess the Submission claim. Also send x-user-agent and x-source-agent: SDK.
Sanctions Search APIx-api-keySent with the Tenant Identifier in the path.
RTRA Monitoring APIx-header-api-keyAPI key generated in the Assentify Developer section with access to RTRA.
Signature Integration APIx-ms-keyIntegration API key issued by Assentify. Tenant sent in X-Tenant-Identifier (a valid GUID).

The Tenant Identifier is passed alongside the key. It appears as the {tenantIdentifier} path segment on Sanctions Search, in the X-Tenant-Identifier header on Signature Integration, in the X-Tenant-Identifier header on Submission, and as a form field on the Clients API endpoints.

curl --location 'https://api.gateway.assentify.com/webapi/v1/Manager/Start/{hashString}' \
--header 'x-api-key: {API-KEY}' \
--header 'x-user-agent: {USERAGENT}' \
--header 'x-source-agent: SDK'
curl -X POST https://api.rtra.assentify.com/v1/api/rtra/check \
  -H "x-header-api-key: YOUR_API_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d @transaction.json
A 200 is not always proof of successOn the Signature Integration API, cert-service failures are swallowed rather than returned as a 500. Always inspect the status field of the response (Completed vs Failed) before treating a document as signed.

Get an API Key and Tenant Identifier

API keys are generated from the Developer section of the Assentify Platform. The RTRA documentation states that all of its APIs require an API key generated from the developer section for security and access, and the Signature Integration key is issued by Assentify. If you do not have access, ask your administrator to provision a key with the claims your integration needs (for example, the Submission claim for the Submission API, or RTRA access for the RTRA engine).

  1. Sign in to the Assentify Platform and open the Developers section.
  2. Generate an API key with the access your integration requires (for example the Submission claim, or RTRA access).
  3. Note your Tenant Identifier, the GUID that identifies your organization on the platform.
  4. Send the key in the correct header for the service and pass the Tenant Identifier where the service expects it (path, header, or form field).
Custom properties in a flowTo pass custom properties through a flow, first specify them in the Flow Builder JSON viewer, then generate a Flow URI that includes those properties from the Clients API.
  1. Log in to the Assentify Admin Portal at https://admin.assentify.com and open the Digital Services section.
  2. Click the flow you want to add properties to, then in the top right click Edit Engagement.
  3. Click the magnifying glass icon of the Connector Block to open the JSON Viewer.
  4. Enter the property name, then click the plus button to add it.

Interactive Swagger Reference

The Clients API ships an interactive Swagger reference where you can inspect endpoints, fill in parameters, and execute live calls. For example, the Engagement endpoint returns a Flow URI in its response.

Swagger https://clients.assentify.com/swagger/index.html
  1. Go to the Assentify Clients API at https://clients.assentify.com/swagger/index.html.
  2. Under the Engagement section, click the /api/Engagement endpoint.
  3. Fill in the form data.
  4. Click Execute. The response contains the URI.

Per-Service Base URLs

Each service is reached at its own host. Use the base URL that matches the API you are calling.

ServiceBase URLAuth header
Clients APIhttps://clients.assentify.comx-api-key
Submission APIhttps://api.gateway.assentify.comx-api-key
Sanctions Search APIhttps://sanctions.assentify.comx-api-key
RTRA Monitoring APIhttps://api.rtra.assentify.comx-header-api-key
Signature Integration APIhttps://signme.assentify.comx-ms-key
Cognitive Services PipelineThe Pipeline REST endpoints sit under {ORCHESTRATOR_BASE_URL}/api/Pipeline/.... These endpoints do not enforce app-level authentication and read no tenant headers; they are reached through the platform gateway. Confirm the exact host and whether a gateway token is required with the platform team before shipping.

API Reference Pages

Open the page for the service you want to integrate.

APIWhat it doesBase URL
Clients APIPass custom properties through a Flow URI, then query and search clients (KYC documents, signed documents, interaction history, additional information, AML screening).clients.assentify.com
Submission APIHeadless submission of flow content. Start a flow, build the submission model, and Submit to run processes such as automated AML, decisions, and client creation.api.gateway.assentify.com
Sanctions Search APISmart Search against sanctions data by keyword, with optional country and list filters.sanctions.assentify.com
RTRA Monitoring APIReal-time risk assessment on transactions (CLEARED, FLAGGED, or ON HOLD) plus a paginated, filterable Hold/Flagged/Review report.api.rtra.assentify.com
Signature Integration APIServer-to-server document signing. Render a tenant template or sign supplied PDF bytes, returning the signed PDF in the response.signme.assentify.com
Cognitive Services PipelineValidate, dry-run, and execute the document-processing pipeline over JSON, with a streaming NDJSON Execute endpoint.Orchestrator gateway
Start with SwaggerThe Clients API Swagger reference at https://clients.assentify.com/swagger/index.html is the quickest way to try a live call and confirm your key and Tenant Identifier work.