--- title: "Name search in the UN Security Council sanctions list" method: POST path: "/un/sanctions" tags: ["United Nations Security Council"] --- # Name search in the UN Security Council sanctions list `POST /un/sanctions` ## Request - Base URL: `https://api.directdigital.com.br` - URL: `https://api.directdigital.com.br/un/sanctions` - Auth: API key in header `token` - TypeScript: (a function with typed inputs; its response is checked against the schema) Searches a name in the Consolidated List of the United Nations Security Council: individuals and entities subject to UN sanctions. **Source:** periodically updated copy of the UN Security Council Consolidated List. **Returns:** number of entries found and, for each, the similarity to the name searched, full name, aliases, list type, listing date, UN reference number, sanctions regime and comments. **Execution:** synchronous; no PDF. **Note:** Only names very similar to the one searched are returned. Code 1 is returned even when nothing is found; check `NumeroOcorrencias`. ## Query parameters - `test_mode` boolean - `lightweight` boolean ## Request body `application/x-www-form-urlencoded` - object - `name` string, required: Full name of the person or entity to search. - `person` boolean, required: `true` to search individuals, `false` to search entities. ## Response `200` Success - UnSanctionsResponse: UnSanctionsResponse - `ApiResultType` 'Success' | 'SuccessWithRemarks' | 'InvalidInput' | 'DataUnavailable' | 'NotFound' | 'InvalidParameters' | 'UnsupportedCombination' | 'RemoteUnavailable' | 'Timeout' | 'RetryLimitReached' | 'RemoteError' | 'InProgress' | 'InsufficientCredits' | 'ConcurrentLimitReached' | 'TransactionUnavailable' | 'AccessDenied' | 'TransactionCancelled' | 'Created' | 'Updated' | 'Deleted' | 'InternalError' | 'ValidationFailed' | 'Conflict' | 'ResourceLocked' | 'PendingApproval' | 'Approved' | 'Rejected' | 'Cancelled' | 'Paused' | 'Resumed': New unified result type for queries and administrative operations. Replaces TransactionResultType with better semantics. - `BalanceInBrl` number, double: Current balance in BRL. - `BalanceInCredits` integer: Current balance in credits. - `DataSourceCategory` string: Data source category - `Date` string, date-time: Transaction date. - `ElapsedTimeInMilliseconds` integer: Execution time (in milliseconds). - `ExecutedDataSourceName` string: Display name of the query type that actually ran. - `ExecutedDataSourceTypeId` integer: Id of the query type that actually ran (the one recorded on the transaction), which may differ from the requested type when the route is generic per state or when a master delegates to a sub-query. - `HasOriginalFiles` boolean: Indicates that the transaction carries original files from the source (the issued certificate, for example) for download at OriginalFilesUrl. False does not mean the URL does not exist: it is always built. - `HasPdf` boolean: Indicates that there is a PDF proof document for the result. - `Message` string: Message. - `OriginalFilesUrl` string: URL to download the transaction's original files (when available). - `OutdatedResult` boolean: Indicates that the result is dated. - `PdfUrl` string: URL to download the transaction's PDF proof document (when available). - `ResultSubtype` string: Specific result subtype to provide additional context (e.g.: 'duplicate_name', 'invalid_cpf'). - `ResultTypeCode` integer: Numeric result code (compatible with TransactionResultTypeCode but extensible). - `TotalCost` number, double: Internal use only. - `TotalCostInCredits` integer: Total transaction cost in credits. - `TransactionResultType` 'Success' | 'SuccessWithRemarks' | 'InvalidInputData' | 'UnavailableData' | 'EntityNotFound' | 'InvalidParameters' | 'ParametersNotSupported' | 'RemoteSystemUnavailable' | 'Timeout' | 'AttemptsLimitReached' | 'RemoteSystemError' | 'AsyncExecutionInProgress' | 'AwaitingExecution' | 'BirthDateRequired' | 'InsufficientBalance' | 'SimultaneousTransactionsLimitReached' | 'TransactionUnavailable' | 'AccessDenied' | 'TransactionCancelled' | 'InternalError':
TransactionResultType CodeTransactionResultTypeFinalBillableError
1SuccessTrueTrueFalse
2Partial success or success with remarksTrueTrueFalse
3Invalid input or documentTrueFalseTrue
4Data not availableTrue (for the day)FalseFalse
5Entity or document nonexistent/not foundTrueTrueFalse
6Invalid input parametersTrueFalseTrue
7Unsupported parameter combinationTrueFalseTrue
8Data source or remote system unavailableFalseFalseTrue
9Time limit exceededFalseFalseTrue
10Attempts limit reachedFalseFalseTrue
11Error in the data source or remote systemFalseFalseTrue
12Transaction in progressFalseFalseFalse
101Insufficient credit balance, please contact usFalseFalseTrue
102Simultaneous transactions limit reached, please contact usFalseFalseTrue
103Transaction not available, please contact usFalseFalseTrue
104Invalid credentials or access denied, please contact usFalseFalseTrue
105Transaction cancelled, please contact usFalseFalseTrue
255*Unexpected internal error, please contact usTrue (for the day)FalseTrue
* Query under maintenance, try again later or contact Exato to report the problem
- `TransactionResultTypeCode` integer: Transaction result type code. - `UniqueIdentifier` string: Unique transaction identifier. Store it for control and debugging. - `Result` UnSanctionsResult: UnSanctionsResult - `NumeroOcorrencias` integer: Number of list entries found; `0` when there is no match. - `Ocorrencias` UnSanctionsResultItem[]: List entries whose name is similar to the name searched, most similar first. - `Similarity` number, double: Similarity between the name searched and the name of the entry, from 0 to 1. - `FullName` string: Full name of the individual or entity. - `NameOriginalScript` string: Name in its original script, when listed. - `AliasName` string: Alias that matched the search, when the match was on an alias. - `AliasNameEntry` string: Alias entries of the individual or entity. - `ListType` string: Type of record: individual or entity. - `ListedOn` string, date-time: Date the individual or entity was listed. - `ReferenceNumber` string: UN reference number (e.g. QDi.001). - `UnListType` string: UN sanctions regime (committee list) of the entry. - `Comments` string: Comments of the entry, as published in the list. - `AddressCountry` string: Country of the address. - `Recencia` string, date-time: Date of the list data used in the query. - `Versionnum` integer: Version number of the entry in the UN list. - `LastDayUpdated` string: Last update date(s) of the entry in the UN list. - `InsertedAt` string, date-time: Date the entry was loaded into the data used in the query. --- [API](https://skmtc.dev/directdigital/apis/directdigital.md) - [All operations](https://skmtc.dev/directdigital/apis/directdigital/llms.txt) - [OpenAPI document](https://skmtc.dev/directdigital/apis/directdigital/revisions/3b7fd216787b?raw)