Steps
When a system-initiated RFI is created by a BFI, you are notified in one of two ways:- In the synchronous response to the payment creation endpoint. When you create
a payment, the endpoint responds with the created payment record containing a
non-null
activeRfifield. - Asynchronously by an RFI webhook. This can occur at any time in the payment flow after the payment is created. The RFI webhook doesn’t contain the entire RFI object.
Step 1: Get the RFI requirements and certificate
Before you respond to an RFI, you need to get the requirements and the certificate used for encrypting RFI responses. The RFI requirements are available in the RFI object. If the RFI was created synchronously, the full object is included in theactiveRfi field of the
payment object. If the RFI was created asynchronously, you must retrieve the
full object using the
get details for an RFI endpoint. The
following is an example RFI object:
JSON
Step 2: Create the RFI response
You must provide all of the fields that are marked as required. Circle recommends providing the fields marked as optional for the highest likelihood of an approved RFI. If you do not have the requested information about the sender, you should request it. Once you have all of the required information, you can create the RFI response. Format it into the appropriate JSON format, based on the schema provided in thefieldRequirements parameter.
Before encrypting and sending the response, you should validate the JSON
response object against the JSON schema. See
How-to: Integrate with JSON Schema for
more information.
The following is an example RFI response:
JSON
Step 3: Encrypt the RFI response
The RFI response must be encrypted before it is sent to the BFI. It is encrypted in the same manner as the travel rule and beneficiary account data. For a full guide on the encryption process, see How-to: Encrypt Travel Rule and Beneficiary Account Data.Step 4: Submit the RFI response
Submit the encrypted RFI response with the submit RFI data endpoint . The request should include the encrypted data and the version of the RFI JSON Schema. The version should match the version in thefieldRequirements
parameter of the RFI object. An example request body is shown below:
JSON
Step 5: Upload required files
If the RFI includes afileRequirements field, you must upload documentation
about the sender in addition to submitting the RFI response. Files must be
encrypted and uploaded one at a time to the
upload RFI file endpoint. You
can upload files before or after submitting the RFI response, as long as it is
before the RFI decision is made.
See How-to: Encrypt Files for RFI Transmission for
more information on how to encrypt files.
The upload RFI file endpoint
accepts a multipart/form-data request body in three parts. The request body
should include the encrypted file, the encryption details, and the file
metadata. The file metadata should include the filename, file type, and file
key. The file key should match the fileKey in the fileRequirements field of
the RFI object.
The following is an example request body:
Text