API Endpoints

Entities Endpoint

Entities represent users or businesses on your platform.

ENDPOINT

DESCRIPTION

GET /entities

Retrieves an existing entity.

POST /entities/list

Retrieves a list of all entities in your environment.

POST /entities/create

Creates an entity.

PUT /entities/<unit21_id>/update

Updates an existing entity.

PUT /entities/<unit21_id>/add-instruments

Creates associations between an entity and transaction instruments.

PUT /entities/<unit21_id>/link-media

Adds rich media objects (images, videos, etc.) to an existing entity.

Events Endpoint

Events represent time-associated occurrences (as events and transactions) on your platform that involve one or more entities or instruments.

ENDPOINT

DESCRIPTION

POST /events/create

ƒRules

POST /entities/list

Retrieves a list of all events in your environment.

PUT /events/<unit21_id>/update

Updates an existing event.

GET /events/<unit21_id>

Retrieves an existing event.

Instruments Endpoint

Instruments represent any physical, digital, or logical intermediary between an entity and a transaction event.

ENDPOINT

DESCRIPTION

POST /instruments/create

Creates an instrument.

PUT /instruments/<unit21_id>/update

Updates an existing instrument.

GET /instruments/<unit21_id>

Retrieves an existing instruments.

POST /instruments/list

Retrieves a list of all instruments in your environment.

Devices Endpoint

Devices represent any computer or physical device used to execute events.

ENDPOINT

DESCRIPTION

POST /devices/create

Creates a device(s).

PUT /devices/<unit21_id>/update

Updates an existing device.

GET /devices/<unit21_id>

Retrieves an existing devices.

POST /devices/list

Retrieves a list of all devices in your environment.

Rules Endpoint

Rules are the models that find suspicious and fraudulent transactions. Rules create alerts that can be turned into cases with flagged entities, instruments, and transactions.

ENDPOINT

DESCRIPTION

GET /rules/list

Returns an array of all the rules in your environment.

GET /rules/<unit21_id>

Retrieves an existing rule.

Alerts Endpoint

Alerts originate from models that flag suspicious transactions. You can import external alerts into Unit21.

ENDPOINT

DESCRIPTION

POST /alerts/create

Creates an alert.

PUT /alerts/<unit21_id>/update

Updates an existing alert.

PUT /alerts/<unit21_id>/link-media

Adds an image/media to an alert.

GET /alerts/<unit21_id>

Retrieves the details of an existing alert.

POST /alerts/list

Retrieves a list of all alerts in your environment.

Cases Endpoint

A case is an alert under investigation that can be directly escalated to a suspicious activity report.

ENDPOINT

DESCRIPTION

POST /cases/create

Creates a case.

PUT /cases/<unit21_id>/update

Updates an existing case.

PUT /cases/<unit21_id>/link-media

Adds an image/media to a case.

GET /cases/<unit21_id>

Retrieves the details of an existing case.

POST /cases/list

Retrieves a paginated list of cases.

SARs Endpoint

Suspicious Activity Reports are one of the outcomes of a investigated case and can be filed to finCEN.

ENDPOINT

DESCRIPTION

POST /sars/list

Retrieves a paginated list of SARs.

GET /sars/<unit21_id>

Retrieves the details of an existing SAR.

Agents Endpoint

Agents are your compliance & monitoring employees/officers using Unit21.

ENDPOINT

DESCRIPTION

GET /agents/list

Returns an array of all the agents in your environment.

Verification Form Endpoint

Unit21 provides the ability to automate the identity verification and collection of users via verification forms The verification endpoint creates a URL to gather user input. The URL is only valid for a specified amount of time.

ENDPOINT

DESCRIPTION

POST /verification-forms/create

Creates a verification form.

Tag Endpoint

Tags are a flexible and dynamic solution for object-labeling in Unit21's system. They can be associated to alerts, cases, rules, SARs, entities, events, instruments, agents, and action triggers.

ENDPOINT

DESCRIPTION

POST /tag-associations/list

Retrieves a list of of tags/object pairs that matches the filter criteria passed in.

Blacklist/Matchlist Endpoint

Matchlists are lists of information (that can include IP addresses, name, ssn...) that can be used to create models that flag suspicious transactions.

ENDPOINT

DESCRIPTION

POST /blacklists/list

Retrieves a list of all blacklists in your environment.

POST /blacklists/create

Creates a blacklist.

POST /blacklists/<blacklist_id>/add-values

Updates an existing blacklist with a new set of values specified.

Datafiles Endpoint

The datafiles API is used to upload a datafile in order to bulk upload multiple objects of the same type (either entity, event, or instrument).

ENDPOINT

DESCRIPTION

POST /datafiles/create

Uploads a file with (bulk) entity, event or instrument information.

GET /datafiles/<unit21_id>

Retrieves details such as the current status of a datafile.

POST datafiles/<unit21_id>/mappings

Retrieves mappings of a datafile.

Webhooks Endpoint

The webhook API is used to update the URL for your company that will receive callbacks from Unit21.

ENDPOINT

DESCRIPTION

PUT /webhooks/<unit21_id>/update

Change the URL of an existing webhook.

Verification Endpoint

ENDPOINT

DESCRIPTION

POST /entities/{unit21_id}/verify

Verifies an entity but running a verification workflow.

POST /entities/{unit21_id}/link-verification-result

Add the verification result from an external ID provider to an entity on the Unit21 system.

GET /verification/result/{workflow_id}

Returns all the information from the verification workflow execution for a specific entity.

POST /entities/{unit21_id}/continuous-monitoring

Add or disable Socure continuous monitoring for an entity.


Did this page help you?