Fields
Needs FFL orders: Read and write, a permission of FFL Checkout stores. For a buyer whose dealer the registry does not have: send the scan of the dealer's licence the buyer gave your checkout, from your server, as multipart/form-data.
| Field | Type | Rule |
|---|---|---|
| filerequired | file | The scan or photograph: PDF, PNG, JPG or WEBP, at most 10 MB. |
| kindoptional | string | ffl, the dealer's licence, the default; or sot, their SOT stamp, for NFA items. |
- Read, then approved. FFL Monkey reads the file and approves it, by itself or by its staff, the same way it does an upload made in its own checkout picker. Ask GET /ffl-contributions/{contribution} what became of it: once approved it answers the dealer's licence number, to report the order and its transfer with.
- 6 uploads a minute for your store, whichever key sends them, the same budget as your checkout picker's, refused ones included.
What it answers
| Field | Meaning |
|---|---|
| id | The upload's id: ask GET /ffl-contributions/{id} about it. |
| kind | ffl or sot. |
| status | queued: waiting to be read. |
Returns
- 202Taken, and queued to be read, in
data. - 422validation_failed: no file, a file of another type or over 10 MB, or a
kindit does not know. - 429rate_limited: more than 6 uploads in a minute for your store.
This endpoint can also answer 401 invalid_api_key, 403 license_not_active, 403 product_not_included, 403 insufficient_scope and 429 rate_limited.