Upload RFI file
posthttps://api.circle.com/v1/cpn/payments/{paymentId}/rfis/{rfiId}/files
- Reference
- Playground
Upload encrypted RFI file.
Path parameters
rfiId
uuid
Required
The RFI id created previously.
paymentId
uuid
Required
The payment id created previously.
Body parameters
file
string
Required
The binary file content, encrypted using AES-128-GCM. The corresponding 'encryptedAesKey' and 'iv' must be used for decryption
encryption
object
Required
Encryption details required to decrypt the file
encryptedAesKey
string
A JSON Web Encryption (JWE) compact string format as defined in RFC 7516
iv
string
A Base64-encoded, 12-byte Initialization Vector (IV) used for AES-GCM encryption
fileMetadata
object
Required
Contains metadata about the submitted file
fileName
string
Name of the file being submitted
fileType
string
File type for RFI file (Request for Information)
Allowed valuesapplication/pdfapplication/postscriptapplication/mswordapplication/x-msiapplication/vnd.openxmlformats-officedocument.wordprocessingml.documentapplication/vnd.ms-excelapplication/vnd.openxmlformats-officedocument.spreadsheetml.sheetimage/jpegimage/jp2image/pngimage/apngimage/heicimage/heiftext/csv
fileKey
string
File Key for RFI (Request for Information)
Allowed valuesFORMATION_DOCUMENTORG_STRUCTUREINVOICEBENEFICIARY_OWNERS_DOCUMENTID_DOCUMENTPROOF_OF_ADDRESS_DOCUMENTADDITIONAL_DOCUMENTS
Response
RequestChoose a language
ResponseChoose an example
1{
2 "code": 400,
3 "message": "Bad request."
4}Did this page help you?
© 2023-2025 Circle Technology Services, LLC. All rights reserved.
