Skip to main content
POST
Upload a document

Authorizations

Authorization
string
header
required

Your secret API key: fc_test_… in test mode, fc_live_… in live mode.

Path Parameters

registration_id
string
required

Query Parameters

simulate
string | null

Test keys only: verified (default) or rejected. Ignored with a live key.

Body

multipart/form-data
kind
string
required

means_of_id, passport, signature or supporting_document

file
file
required
proprietor
integer
default:0

Index of the proprietor in proprietors.

Response

Successful Response

id
string
required

doc_…

registration_id
string
required
proprietor
integer
required

Index of the proprietor in proprietors.

kind
enum<string>
required
Available options:
means_of_id,
passport,
signature,
supporting_document
filename
string
required
content_type
string | null
required
size
integer
required

Bytes.

status
enum<string>
required
Available options:
verified,
rejected
reason
string | null
required

Why it was rejected.

created_at
string | null
required
object
string
default:document
Allowed value: "document"