Skip to main content
GET
Get a BOM report

Authorizations

Authorization
string
header
required

An API key created in the PartFinder console at https://console.partfinder.dev, or a customer key created with POST /v1/keys. Send as Authorization: Bearer <key>. Revocation takes effect within approximately one minute.

Path Parameters

id
string
required

The BOM id returned by POST /v1/bom.

Query Parameters

country
string

The buyer's country, as a two-letter ISO 3166-1 code. The scores are computed for a buyer there, and scored_for_country names it. Without it the scores are not tied to any buyer location.

Pattern: ^[A-Za-z]{2}$

Response

The BOM report.

as_of
string<date-time>
required

ISO 8601. How current the data in this response is.

summary
string
required

Plain language an agent can relay without re-deriving it.

notice
string
required

Informational-use notice. Always present.

bom
object
required
scored_for_country
string | null
required

The buyer country the scores are computed for, from the country parameter. Null when no country was sent: the scores are then not tied to any buyer location.

risk
object
required
countries
object[]
required

Where the BOM is made, most lines first. Lines with no known origin are not listed.

parts
object[]
required

Every line, in the order submitted. Unresolved lines are present with nulls.