Embargo API Reference

The Pangea Embargo API lets developers quickly check IPs and country codes against known sanction and trade embargo lists.

Base URL

embargo.<csp>.<region>.pangea.cloud

• Embargo Documentation
• OpenAPI Specification

post/v1/ip/check

cURL

Code Snippet Language

curl -sSLX POST 'https://embargo.aws.us.pangea.cloud/v1/ip/check' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

200

Code Snippet Language

Check IP

POST

https://embargo.aws.us.pangea.cloud/v1/ip/check

Check IPs against known sanction and trade embargo lists.

required parameters

ip

string (ip-address)

Geolocate this IP and check the corresponding country against the enabled embargo lists.

ip

ip

Response Fields

Response Schema

object

Pangea standard response schema

result

object

count

integer

sanctions

array<object>

List of enabled sanctions containing the country where the IP originates

list_name

string

Name of list

embargoed_country_name

string

Name of embargoed country

embargoed_country_iso_code

string

issuing_country

string

Country that created the list containing this sanction

annotations

object

Additional information about this sanction

request_id

string

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"

request_time

string

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"

response_time

string

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"

status

string

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"

summary

string

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

post/v1/iso/check

cURL

Code Snippet Language

curl -sSLX POST 'https://embargo.aws.us.pangea.cloud/v1/iso/check' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

200

Code Snippet Language

ISO Code Check

POST

https://embargo.aws.us.pangea.cloud/v1/iso/check

Check country codes against known sanction and trade embargo lists.

required parameters

iso_code

string

Check this two character country ISO code against the enabled embargo lists.

iso_code

iso_code

Response Fields

Response Schema

object

Pangea standard response schema

result

object

count

integer

sanctions

array<object>

List of enabled sanctions containing this country

list_name

string

Name of list

embargoed_country_name

string

Name of embargoed country

embargoed_country_iso_code

string

issuing_country

string

Country that created the list containing this sanction

annotations

object

Additional information about this sanction

request_id

string

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"

request_time

string

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"

response_time

string

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"

status

string

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"

summary

string

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

Was this article helpful?

Contact us