Card payments

OFAC

6min

Use Cross River OFAC screening APIs to verify OFAC compliance, get screening status, and get details about a compliance scan using a scan ID, so you can be sure that individuals don't put you or the bank at risk of fraud or other criminal behavior.

Get started with Cross River APIs.

The endpoints listed in this table are described in detail in the sections below.

Action

API Call

Description

POST /api/OfacScan

Checks OFAC compliance before proceeding with an international transaction

GET /api/OfacScan/{scanId}/{sourceSenderId}

Returns international transaction screening requirements compliance details

GET /api/OfacScan/{scanId}

Returns details about a compliance scan

Verify OFAC compliance (OFAC scan)

Checks OFAC compliance.

Cross River requires OFAC screening before sending an international money transfer. This API endpoint makes this check.

IMPORTANT Every international transaction requires a new OFAC key.

POST
Request
Response
Body Parameters
requestId
optional
String
The GUID that enables the application to link request with response.
sourceSenderId
optional
String
The GUID that identifies the merchant partner.
cardToken
required
String
A randomly generated character string that relates to the consumer's payment card (15 to 38 alphanumeric characters). Matches the creditCardToken in the response.


Get OFAC screening status

Returns details showing compliance with international transaction screening requirements.The API makes the request based on the scanId and the sourceSender (partner) identifier.

GET
Request
Body Parameters
scanId
required
String
Matches the RequestId found in the response. Use this GUID to identify this scan at a later time. Note: This is the RequestId you sent in a specific OfacScan call.
sourceSenderId
required
String
The GUID that identifies the merchant partner


Response attributes

The response attributes for this call are the same as for Verify OFAC compliance.

Get OFAC scan ID

Returns details about a particular compliance scan, based on a specific request identifier.

GET
Request
Body Parameters
scanId
required
String
Matches the RequestId found in the response. Use this GUID to identify this scan at a later time.
sourceSenderId
optional
String
The GUID that identifies the merchant partner


Response attributes

The response attributes for this call are the same as for Verify OFAC compliance.

Related topics

🤔
Have a question?
Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.