Unit21
**Unit21 provides:** - Transaction Monitoring - create rules to find fraudulent transactions - Case Management - investigate potential offenders and suspicious transactions - Report Filing and Actionable Webhooks - report offenders to the authorities or ban them Chat with us live on Discord: https://discord.gg/wxJxGsZgha
7 subscribers
48 endpoints
The in-depth APIMemo review for this API hasn't been published yet —
the data below comes straight from the public marketplace listing.
Unit21 endpoints
| Method | Endpoint | Description |
|---|---|---|
| Entities API | ||
| POST |
Create entity /entities/create |
Creates a new entity, sending entity data in the request body. If the `/entities/create` API is called for an entity that already exists in our system, it is treated it as an… |
| GET |
Get entity /{org_name}/entities/{entity_id} |
Returns all data objects belonging to a single entity, including `general_data`, `document_data`, etc. [Placeholder](https://docs.unit21.ai/reference/placeholder-objects)… |
| PUT |
Update entity /{org_name}/entities/{entity_id}/update |
Updates an entity's information using the `entity_id` from your platform. Updating an entity has no required fields. You MAY send any subset of the fields that the… |
| PUT |
Add instruments to entity /{org_name}/entities/{entity_id}/add-instruments |
Associate an entity with an array of instruments. Specify the `instrument_id` of the instrument when associating instruments.… |
| PUT |
Add media to entity /{org_name}/entities/{entity_id}/link-media |
Adds rich media objects (images, videos, etc.) to an existing entity. [Placeholder](https://docs.unit21.ai/reference/placeholder-objects) entities cannot be updated. This… |
| PUT |
Delete entity media /{org_name}/entities/{entity_id}/delete-all-media |
Deletes all rich media objects (images, videos, etc.) belonging to an existing entity. [Placeholder](https://docs.unit21.ai/reference/placeholder-objects) entities cannot be… |
| POST |
Bulk export entities /entities/bulk-export |
Initiates an email and dashboard export of entities. The export will be as a CSV file. [Placeholder](https://docs.unit21.ai/reference/placeholder-objects) entities are not… |
| Instruments API | ||
| POST |
Create an instrument /instruments/create |
Creates a new instrument, sending instrument data in the request body. Recommended values for `instrument_type` include: account, crypto_address, digital_wallet, credit_card,… |
| GET |
Get an instrument /{org_name}/instruments/{instrument_id} |
Returns all data objects belonging to a single instrument. [Placeholder](https://docs.unit21.ai/reference/placeholder-objects) instruments are not listed. This endpoint requires… |
| PUT |
Update an instrument /{org_name}/instruments/{instrument_id}/update |
Updates an instrument's information using the `instrument_id` from your platform. This endpoint requires the `instrument_id` which is a unique ID created by your organization to… |
| POST |
Bulk export instruments /instruments/bulk-export |
Initiates an email and dashboard export of instruments. The export will be as a CSV file. [Placeholder](https://docs.unit21.ai/reference/placeholder-objects) instruments are not… |
| Rules API | ||
| POST |
List rules /rules/list |
Returns paginated list of of top-level information about rules. Because the response is paginated, the request body has a `limit` and `offset` field. At least one must be filled.… |
| GET |
Get a rule /rules/{unit21_id} |
Returns all data objects belonging to a single rule. This endpoint requires the `unit21_id` which is a unique ID created by Unit21 when the rule is first created. |
| POST |
Bulk export rules /rules/bulk-export |
Initiates an email and dashboard export of rules. The export will be as a CSV file. Either the agent `ID` or `email` is required to begin the export. Either the `filters` or the… |
| Events API | ||
| POST |
Create an event /events/create |
Creates a new event, sending event data in the request body. Two objects are required: `general_data` and either `transaction_data` or `action_data`. `general_data` requires the… |
| POST |
Run real-time rules on an event /evaluate |
Runs real-time rules on a particular event, the details of which are sent in the request body. To save the event that was evaluated, it must be sent to the event creation… |
| GET |
Get an event /{org_name}/events/{event_id} |
Returns all data objects belonging to a single event. This endpoint requires the `events_id` which is a unique ID created by your organization to identify the event. The… |
| PUT |
Update event /{org_name}/events/{event_id}/update |
Update an event using the `event_id` from your platform. Updating an event has no required fields. You MAY send any subset of the fields that the events/create endpoint accepts.… |
| PUT |
Add media to an event /{org_name}/events/{event_id}/link-media |
Adds rich media objects (images, videos, etc.) to an existing event. [Placeholder](https://docs.unit21.ai/reference/placeholder-objects) events cannot be updated. This endpoint… |
| POST |
Bulk export events /events/bulk-export |
Initiates an email and dashboard export of events. The export will be as a CSV file. Either the agent `ID` or `email` is required to begin the export. Either the `filters` or the… |
| POST |
Bulk export transactions /txn-events/bulk-export |
Initiates an email and dashboard export of events. The export will be as a CSV file. Either the agent `ID` or `email` is required to begin the export. Either the `filters` or the… |
| Agents API | ||
| PUT |
Deactivate an agent /agents/{agent_email}/deactivate |
Archives an agent so that he/she can no longer log in to the dashboard. |
| GET |
List agents /agents/list |
Returns an array of all agents in your organization who are using the environment. There are no options or filters for this endpoint. The request will return ALL agents. |
| Alerts API | ||
| POST |
List alerts /alerts/list |
Returns an array of top-level information about alerts in your environment. Because the response is paginated, the request body has a `limit` and `offset` field. At least one… |
| POST |
Create alerts /alerts/create |
Creates a new alert, sending alert data in the request body. To create an Alert, you MUST include the following fields: `alert_id`, `alert_type`, `created_at`, `title`, and… |
| GET |
Get an alert /alerts/{unit21_id} |
Returns all data objects belonging to a single alert. This endpoint requires the `unit21_id` which is a unique ID created by Unit21 when the entity is first created. |
| PUT |
Update alert /alerts/{unit21_id}/update |
Updates an alert's information using the `unit21_id`. ONLY WORKS ON EXTERNAL ALERTS. Updating an alert has no required fields. You MAY send any subset of the fields that the… |
| PUT |
Add media to an alert /alerts/{unit21_id}/link-media |
Adds rich media objects (images, videos, etc.) to an existing alert. This endpoint is useful for sending in rich media such as profile pictures, ID card scans, official documents… |
| POST |
Bulk export alerts /alerts/bulk-export |
Initiates an email and dashboard export of alerts. The export will be as a CSV file. Either the agent `ID` or `email` is required to begin the export. Either the `filters` or the… |
| Cases API | ||
| POST |
List cases /cases/list |
Returns an array of top-level information about cases in your environment. Because the response is paginated, the request body has a `limit` and `offset` field. At least one must… |
| POST |
Create a case /cases/create |
Creates a new case, sending case data in the request body. To create a case, you MUST include the following fields: `case_id`, `title`, and `created_at`. The other top-level… |
| GET |
Get a case /cases/{unit21_id} |
Returns all data objects belonging to a single case. This endpoint requires the `unit21_id` which is a unique ID created by Unit21 when the case is first created. |
| PUT |
Update case /cases/{unit21_id}/update |
Update a case through its `unit21_id`. ONLY EXTERNAL CASES CAN BE UPDATED! Updating a case has no required fields. You MAY send any subset of the fields that the `cases/create`… |
| PUT |
Add media to a case /cases/{unit21_id}/link-media |
Adds rich media objects (images, videos, etc.) to an existing case. This endpoint is useful for sending in rich media such as profile pictures, ID card scans, official documents… |
| POST |
Bulk export cases /cases/bulk-export |
Initiates an email and dashboard export of cases. The export will be as a CSV file. Either the agent `ID` or `email` is required to begin the export. Either the `filters` or the… |
| Sars API | ||
| POST |
List sars /sars/list |
Returns paginated list of of top-level information about paths/[email protected] Because the response is paginated, the request body has a `limit` and `offset` field. At least one… |
| GET |
Get a sars /sars/{unit21_id} |
Returns all data objects belonging to a single SAR. This endpoint requires the `unit21_id` which is a unique ID created by Unit21 when the sar is first created. |
| POST |
Bulk export sars /sars/bulk-export |
Initiates an email and dashboard export of sars. The export will be as a CSV file. Either the agent `ID` or `email` is required to begin the export. Either the `filters` or the… |
| Webhooks API | ||
| PUT |
Update webhook URL /webhooks/{unit21_id}/update |
Change the URL of an existing webhook from Unit21. This endpoint requires the `unit21_id` which is a unique ID created by Unit21 when the webhook is first created. |
| Queues API | ||
| GET |
Get a queue /queues/{unit21_id} |
Returns information on a specific queue |
| POST |
List queues /queues/list |
Returns list of Alert, Case and Filing Queues with the following information: - Unit21 ID - Title - Description - Org ID - Type (Alert, Case, Filing) - Subtype (TM, KYC,… |
| Matchlists API | ||
| POST |
Add items to a matchlist /blacklists/{unit21_id}/add-values |
Add items to a matchlist, according to the matchist's `type`. Each request must specify at least **1** object to matchlist. You may add up to **100** values to an existing… |
| POST |
List matchlists /blacklists/list |
Returns an array of matchlist in your environment. Because the response is paginated, the request body has a `limit` and `offset` field. At least one must be filled. * `limit`… |
| POST |
Create a matchlist /blacklists/create |
Create a new matchlist sending matchlist data in the request body. Unit21 currently supports 5 types of matchlists: * `STRING`: Plain strings to match against any text-type… |
| Exports API | ||
| POST |
List exports /file-exports/list |
Returns paginated list exports. It will only show the exports initiated by the requester (The requester is the creator of the API key) **This endpoint omits any exports from the… |
| GET |
Download export /file-exports/download/{file_export_id} |
Returns a signed url to download the file. |
| Datafiles API | ||
| GET |
Get datafile /datafiles/{unit21_id} |
Get details about a datafile. This endpoint requires the `unit21_id` which is a unique ID created by Unit21 when the datafile is first created. |
| POST |
Upload datafiles /datafiles/create |
Bulk upload multiple objects of the same type. Can be entities, events, or instruments. Only one file can be uploaded in a request, with a file size maximum of 1GB. Please add a… |
Unit21 pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|
| PRO | $25 / month | — |
|
| ULTRA | $75 / month | — |
|
| MEGA | $150 / month | — |
|
