Browse endpoints

PEP / Sanction Sources

GET /api/v2/pep_sanction_sources operationId: pep_sanction_sources

Live: https://gdapi.globaldata.net.au/api/v2/pep_sanction_sources · Sandbox: https://sandbox-gdapi.globaldata.net.au/api/v2/pep_sanction_sources

Returns the PEP and sanction sources that PEP / Sanction Search draws on, with a readable name, a short summary and a link to the publisher for each one.

The source values are the same keys that PEP / Sanction Search returns in pep_matches and sanction_matches, so this endpoint can be used to show what each match means and where the data comes from.

Billing

This endpoint is non-billable. It requires the same product access as PEP / Sanction Search.

Responses

200

Successful response

application/json
FieldDescription
message string

A message indicating the result of the request. This will be Ok if the request was successful.

Example: Ok

function string

The function that was called.

Example: pep_sanction_sources

api_reference string (uuid)

A unique identifier for this request. This can be used to track the request in the logs.

Example: fe4291ca-d831-4760-96df-c9cb03b3cd95

pep array of objects

The PEP sources, ordered alphabetically by source.

pep[].source string

The source key. This is the value returned in pep_matches by PEP / Sanction Search.

Example: au_parliament

pep[].name string

The readable name of the source.

Example: Australia Members of Parliament

pep[].summary string or null

A one line summary of what the source contains. null when the publisher does not provide one, or when the details could not be refreshed and no cached copy exists.

Example: Current and recent members of the Australian federal Parliament (House of Representatives and Senate)

pep[].url string (uri) or null

A link to the publisher of the source. null when the publisher does not provide one, or when the details could not be refreshed and no cached copy exists.

Example: https://handbook.aph.gov.au/

sanctions array of objects

The sanction sources, ordered alphabetically by source.

sanctions[].source string

The source key. This is the value returned in sanction_matches by PEP / Sanction Search.

Example: au_dfat_sanctions

sanctions[].name string

The readable name of the source.

Example: Australian Sanctions Consolidated List

sanctions[].summary string or null

A one line summary of what the source contains. null when the publisher does not provide one, or when the details could not be refreshed and no cached copy exists.

Example: The Consolidated List is a list of all persons and entities who are subject to targeted financial sanctions under Australian sanctions law

sanctions[].url string (uri) or null

A link to the publisher of the source. null when the publisher does not provide one, or when the details could not be refreshed and no cached copy exists.

Example: https://www.dfat.gov.au/international-relations/security/sanctions/Pages/sanctions

Standard error responses: 401 402 403 429 5XX See common error responses