POST
/
v1
/
customers
/
{customerId}
/
documents
/
presign
curl --request POST \
  --url https://api.next.orenda.finance/v1/customers/{customerId}/documents/presign \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "collection": "kyc",
  "documentType": "PROOF_OF_ADDRESS",
  "contentType": "application/pdf"
}
'
{
  "success": true,
  "data": {
    "uploadUrl": "https://orenda-kyc-documents.s3.eu-west-1.amazonaws.com/cust_3f9a2b7e/kyc/proof-of-address.pdf?X-Amz-Signature=...",
    "bucket": "orenda-kyc-documents",
    "key": "cust_3f9a2b7e/kyc/proof-of-address.pdf",
    "method": "PUT",
    "contentType": "application/pdf",
    "expiresInSeconds": 900
  }
}

Authorizations

Authorization
string
header
required

The user's access_token from authentication. The program and environment (sandbox/prod) are read from the token.

Path Parameters

customerId
string
required

The customer's ID.

Body

application/json
collection
enum<string>

Upload: required. Download by key: required. Which document collection.

Available options:
kyc,
kyb
documentType
string

Upload: required. A document type from the program's KYC schema.

contentType
string

Upload: optional. MIME type the file will be PUT with, e.g. application/pdf.

applicationId
string

Download: required. The application the document belongs to.

s3Url
string

Download: the document's storage URI (e.g. from the upload response). Use this or collection + key.

key
string

Download: the document's storage key. Send with collection.

expiresInSeconds
number

Optional. How long the URL stays valid (clamped to a server-side maximum).

Response

Presigned URL

success
boolean
Example:

true

data
object