Fields
Only the upload's id, in the address: the one POST /ffl-contributions answered with. Needs FFL orders: Read, a permission of FFL Checkout stores.
Ask again every few minutes until it is decided: FFL Monkey's checkout plugin asks every 15. Never the reading itself or the file.
What it answers
| Field | Meaning |
|---|---|
| id | The upload's id. |
| kind | ffl or sot. |
| status | queued and processing while it is read; auto_approved or approved once the dealer is in the registry; pending_review while FFL Monkey's staff check it; rejected when it is not a licence FFL Monkey can accept; failed when it could not be read. More values may be added. |
| decision_reason | Why it was refused or could not be read, to show the buyer; null otherwise. |
| found | The kinds of document read in the file: ffl, sot, both, or none yet. |
| license_number | The dealer's licence number once the upload is approved, to report the order and its transfer with; null before. |
| dealer_current | Whether that dealer is current: active and not past its expiry date. true or false once the upload is approved; null before. A licence that had lapsed is approved as an expired dealer, so ask the buyer for another dealer. |
| dealer_searchable | Whether the dealer search finds that dealer by its licence number: current, of a licence type that may receive a transfer, and at a mapped address. true or false once the upload is approved; null before. A collector's licence, or one whose address could not be mapped, is current but not searchable, so ask the buyer for another dealer. |
Returns
- 200The upload, in
data. - 404ffl_contribution_not_found: your store has no upload with this id. Another store's upload is the same answer as none.
This endpoint can also answer 401 invalid_api_key, 403 license_not_active, 403 product_not_included, 403 insufficient_scope and 429 rate_limited.