Skip to main content
POST
/
v1
/
cpn
/
payments
/
{paymentId}
/
rfis
/
{rfiId}
/
files
Upload RFI file
curl --request POST \
  --url https://api.circle.com/v1/cpn/payments/{paymentId}/rfis/{rfiId}/files \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'fileMetadata={
  "fileName": "<string>",
  "fileType": "application/pdf",
  "fileKey": "FORMATION_DOCUMENT"
}' \
  --form encryption=@example-file \
  --form encryptedFile=@example-file
This response does not have an example.

Authorizations

​
Authorization
string
header
required

Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are requred to make a successful request.

Path Parameters

​
paymentId
string<uuid>
required

The payment id created previously.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

​
rfiId
string<uuid>
required

The RFI id created previously.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

Body

multipart/form-data
​
fileMetadata
object
required

Contains metadata about the submitted file

​
encryption
object
required

Encryption details required to decrypt the file

​
encryptedFile
file
required

The binary file content, encrypted using AES-128-GCM. The corresponding 'encryptedAesKey' and 'iv' must be used for decryption

Response

RFI File uploaded successfully

⌘I