Get BOP category document requirements

GET

https://api.crisscross.money/v1/toc/bop-categories/:bopCategoryId/requirements

GET

/v1/toc/bop-categories/:bopCategoryId/requirements

$ curl https://api.crisscross.money/v1/toc/bop-categories/bop_550e8400-e29b-41d4-a716-446655440000/requirements \
>      -H "Authorization: Bearer <token>"

1 {
2   "bopCategoryId": "bop_550e8400-e29b-41d4-a716-446655440000",
3   "documents": [
4     {
5       "id": "bop_doc_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
6       "label": "Pro Forma Invoice",
7       "description": "Invoice from the supplier confirming the goods and amounts.",
8       "required": true
9     },
10     {
11       "id": "bop_doc_b2c3d4e5-f6a7-8901-bcde-f12345678901",
12       "label": "Bill of Lading",
13       "description": "Shipping document issued by the carrier.",
14       "required": true
15     },
16     {
17       "id": "bop_doc_c3d4e5f6-a7b8-9012-cdef-123456789012",
18       "label": "Insurance Certificate",
19       "description": "",
20       "required": false
21     }
22   ]
23 }

Returns the supporting document requirements for a specific BOP category.

Authentication

AuthorizationBearer

Token obtained via the login flow.

Path parameters

bopCategoryIdstringRequired

Response

Document requirements for the specified BOP category.

bopCategoryIdstring

documentslist of objects

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error