Create a file

Solutions
Our Solutions
Solve all things payments with a single integration
Solutions overview
Products
Payments
Harness the perfect payment orchestration platform and sell anything, anywhere
KYC
Verify IDs and monitor identities with powerful built-in AML tools
Billing
Price, deliver and manage subscription billing & invoicing
Features
Gateway integrations
Access 110+ payment gateways. Not on the menu? We’ll integrate it free of charge
Risk & Compliance
Reduce PCI compliance scope and fight fraud on a single ultra-secure platform
Reporting & Automation
Leverage data and intelligence to unlock more revenue
Pricing
Resources
FAQs Contact Docs API reference Gateway integrations Customer stories
Blog
About

Nothing Found

Solution Overview

Solutions

Reporting & Automation

Resources

Payments

Payment gateways

Risk management

Billing

Dashboard

Developer docs

FramePay

Rules engine

Guides

API keys

Rebilly REST API

Overview

Customers

Customer Authentication

KYC Documents

AML

Additionally, a file can be sent with:.

multipart/form-data POST request: in this case all property names are the same as the JSON ones (file is an uploaded file)
file body request: the file body is sent as the request body, with the appropriate Content-Type. No additional properties can be set along the request data

The following file types only are allowed:

If using a Publishable Api Key, only private files can be created. The files can later on be modified or used using a secret API key.

Authorizations:

SecretApiKeyJWTPublishableApiKey

header Parameters

Organization-Id

string (ResourceId) <= 50 characters

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Request Body schema: application/json

One of

file required	string The file in base64 encoded format.
isPublic	boolean The File visibility. If public a permalink is provided.
name	string The file name used for downloading.
description	string The file description.
tags	Array of strings The tags list.

Responses

Response Headers
Rate-Limit-Limit	integer The number of allowed requests in the current period.
Rate-Limit-Remaining	integer The number of remaining requests in the current period.
Rate-Limit-Reset	string The date in format defined by RFC 822 when the current period will reset.

Response Schema: application/json

id	string <= 50 characters The resource ID. Defaults to UUID v4.
name	string Original File name.
extension	string The File extension.
description	string The File description.
tags	Array of strings The tags list.
mime	string Enum: "image/png" "image/jpeg" "image/gif" "application/pdf" "audio/mpeg" The mime type.
size	integer The File size in bytes.
width	integer Image width, applicable to images only.
height	integer Image height, applicable to images only.
sha1	string Hash sum of the file.
createdTime	string <date-time> The upload date/time.
updatedTime	string <date-time> The latest update date/time.
isPublic	boolean Is the file available publicly (without authentication). If true, the permalink in the _links section contains the public URL.
	Array of SelfLink (object) or FileDownloadLink (object) or SignedLinkLink (object) or PermalinkLink (object) >= 3 items The links related to resource.

Request samples

Content type

application/json

Example

{"file": "R0lGODlhAQABAIAAAAUEBAAAACwAAAAAAQABAAACAkQBADs=",
"isPublic": false,
"name": "logo.png",
"description": "My file description",
"tags": ["test",
"tags"
]
}

Response samples