Integration Data
Platform API v2.0.0
Release Target: BOMcheck Version 8.3
Please note, all Integration Data endpoints are currently in development. The target release for all currently specified endpoints is BOMcheck Version 8.3 due on 24 February 2025.
None Tiered Usage
Request calls made to all Integration endpoints WILL NOT count towards your API tiered usage allowance. For more info please see Usage Allowance.
GET Substance Lists Index
/integration/substance-lists
Retrieve all BOMcheck supported substance category lists including both IPC 1752A and 1752B list identities (SubstanceCategoryListID).
Each list will contain the full schedule of substance categories applicable to that list and include the substance "Name", "Threshold" and both IPC 1752A and 1752B identities (SubstanceCategoryID).
Additionally, each substance category will include a "CasNumbers" attribute which provides preformatted links to retrieve full information for each substance category including all CAS numbers via the Substance Category Item endpoint.
Payload Example
// URL: /integration/substance-lists
{
"SubstanceCategoriesLists": [
{
"SubstanceCategoryListID": {
"_authority": "IPC",
"_identity_1752a": "EUROHS-0508",
"_identity_1752b": "EUROHS-0508"
},
"SubstanceCategories": [
{
"Name": "Cadmium/Cadmium compounds",
"SubstanceCategoryID": {
"_identity_1752a": "00001",
"_identity_1752b": "00001",
"_authority": "IPC"
},
"Threshold": "0.01% by weight (100 ppm) of homogenous materials",
"CasNumbers": {
"_listUrl_1752a": "https://api.v2.bomcheck.com/v2/integration/substance-lists/EUROHS-0508/substances/00001",
"_listUrl_1752b": "https://api.v2.bomcheck.com/v2/integration/substance-lists/EUROHS-0508/substances/00001"
}
},
// more SubstanceCategories here
]
},
// more SubstanceCategoriesLists here
]
}GET Supported Substance Lists
/integration/substance-lists/supported
Some substance list identities change each time the list is updated. For example, when the IPC releases new REACH Candidate List XML appendices, the list identity reflects the year and month of release (e.g. "EUREACH-0124", "EUREACH-0624"). This can make specifying the currently supported lists challenging within systems integrations.
This endpoint returns BOMcheck's presently supported lists with their current list identities that can be used in other API requests (e.g. Submit/Request or Submit/Declare).
The JSON payload will return a key value array where the key will be a constant (unchanging identifier) for each list and the value will be an object of list attributes including both 1752A and 1752B list identities.
Payload Example
// URL: /integration/substance-lists/supported
{
"SupportedSubstanceCategoriesLists": [
{
"restriction_rohs": {
"_authority": "IPC",
"_identity_1752a": "EUROHS-0508",
"_identity_1752b": "EUROHS-0508",
"Name": "RoHS Restrictions (Directive 2011/65/EU)",
"Info": "Region: European Union (EU)\nOverview: The EU ROHS Directive (Directive 2011/65/EU) restricts the use of specific hazardous substances in electrical and electronic equipment (EEE)",
"RegulationUrl": "https://environment.ec.europa.eu/topics/waste-and-recycling/rohs-directive_en"
}
},
{
"restriction_rohs_upcoming": {
"_authority": "IPC",
"_identity_1752a": "EUROHS-1506",
"_identity_1752b": "EUROHS-1506",
"Name": "RoHS Amendments 1 (Directive 2015/863)",
"Info": "The upcoming RoHS substance restrictions apply to every individual homogenous material in the part."
}
},
{
"restriction_reach_article_67": {
"_authority": "IPC",
"_identity_1752a": "EUREACH-ARTICLE67-2023/1464",
"_identity_1752b": "IPC-1752B/EUREACH-ARTICLE67-2023/1464",
"Name": "REACH Restrictions (Article 67)",
"Info": "REACH Article 67 contains a number of substance restrictions which apply to all suppliers in the supply chain when they supply an article to a customer. BOMcheck follows the approach in the Joint Industry Guide (JIG) and only includes substances which can be found in hardware articles."
}
},
{
"restriction_name_17": {
"_authority": "BOMcheck",
"_identity_1752a": "POPs_Stockholm_Convention",
"_identity_1752b": "IPC-1752B/POPs_Stockholm_Convention",
"Name": "Persistent Organic Pollutants (POPs) Stockholm Convention"
}
},
{
"restriction_substances_restricted_declarable": {
"_authority": "BOMcheck",
"_identity_1752a": "Other_Regulated_Substances",
"_identity_1752b": "IPC-1752B/Other_Regulated_Substances",
"Name": "Other Restricted or Declarable Substances",
"Info": "BOMcheck follows the approach in the Joint Industry Guide (JIG) and only includes substances which can be found in hardware articles."
}
},
{
"restriction_name_18": {
"_authority": "BOMcheck",
"_identity_1752a": "TSCA_Section_6(h)",
"_identity_1752b": "IPC-1752B/TSCA_Section_6(h)",
"Name": "Persistent, Bioaccumulative, and Toxic (PBT) Chemicals under TSCA Section 6(h)"
}
},
{
"restriction_battery_directive": {
"_authority": "BOMcheck",
"_identity_1752a": "Battery_Directive_substance_restrictions",
"_identity_1752b": "Battery_Directive_substance_restrictions",
"Name": "Battery Restrictions",
"Info": "The following restrictions apply to all batteries."
}
},
{
"restriction_reach_candidate_list": {
"_authority": "IPC",
"_identity_1752a": "EUREACH-0624",
"_identity_1752b": "EUREACH-0624",
"Name": "REACH Candidate List (Article 33)"
}
},
{
"restriction_iec_pfas": {
"_authority": "IEC_62474",
"_identity_1752a": "IEC_62474_PFAS_List",
"_identity_1752b": "IEC_62474_PFAS_List",
"Name": "IEC PFAS List"
}
},
{
"restriction_bom_pfas": {
"_authority": "BOMcheck",
"_identity_1752a": "BOMcheck_PFAS_List",
"_identity_1752b": "BOMcheck_PFAS_List",
"Name": "BOMcheck PFAS List"
}
},
{
"restriction_prop65": {
"_authority": "BOMcheck",
"_identity_1752a": "Prop_65_substances",
"_identity_1752b": "Prop_65_substances",
"Name": "California Proposition 65"
}
},
{
"restriction_industry_substance": {
"_authority": "BOMcheck",
"_identity_1752a": "Industry_restricted_and_declarable_substances",
"_identity_1752b": "Industry_restricted_and_declarable_substances",
"Name": "Industry Restricted and Declarable",
"Info": "These substances are restricted by Philips and other leading OEMs to: a) comply with product safety standards in Germany, b) reduce severe environmental or health and safety impacts"
}
}
]
}| Constant | List Name |
|---|---|
| restriction_rohs | RoHS Restrictions (Directive 2011/65/EU) |
| restriction_rohs_upcoming | RoHS Amendments 1 (Directive 2015/863) |
| restriction_reach_article_67 | REACH Restrictions (Article 67) |
| restriction_name_17 | Persistent Organic Pollutants (POPs) Stockholm Convention |
| restriction_substances_restricted_declarable | Other Restricted or Declarable Substances |
| restriction_name_18 | Persistent, Bioaccumulative, and Toxic (PBT) Chemicals under TSCA Section 6(h) |
| restriction_battery_directive | Battery Restrictions |
| restriction_reach_candidate_list | REACH Candidate List (Article 33) |
| restriction_prop65 | California Proposition 65 |
| restriction_industry_substance | Industry Restricted and Declarable |
| restriction_iec_pfas | IEC PFAS List |
| restriction_bom_pfas | BOMcheck PFAS List |
GET Substance Cat Item (with CAS Numbers)
/integration/substance-lists/:ListID/substances/:SubstanceID
Retrieve full details including all associated CAS numbers for any BOMcheck supported substance category (e.g. Lead/lead compounds from RoHS Restrictions list).
URL Parameters
:ListID
The substance category list identity to which the substance category belongs (e.g. "EUROHS-0508"). All list identities can be retrieved from the Substance List Index OR the Supported Substance Lists endpoints.
:SubstanceID
The substance category identity (e.g. "00005"). Identities are issued by the list authority which is generally the IPC or BOMcheck. All list identities can be retrieved from the Substance List Index endpoint.
Please Note
When using a 1752B list identity (e.g. "IPC-1752B/EUREACH-ARTICLE67-2023/1464"), please ensure that the corresponding 1752B substance category identity is used. 1752A and 1752B identities are not always aligned during assignment. If in doubt utilise the preformatted 1752A and 1752B links provided in the Substance List Index response payload.
Payload Example
// URL: /integration/substance-lists/BOMcheck_PFAS_List/substances/00001
{
"SubstanceCategory": {
"Name": "Per and polyfluoroalkyl substances",
"SubstanceCategoryListID": {
"_identity_1752a": "BOMcheck_PFAS_List",
"_identity_1752b": "BOMcheck_PFAS_List",
"_authority": "BOMcheck"
},
"SubstanceCategoryID": {
"_identity_1752a": "00001",
"_identity_1752b": "00001",
"_authority": "BOMcheck"
},
"CasNumbers": [
"56296-78-7",
"83805-11-2",
"54910-89-3",
"134051-91-5",
"134051-92-6",
"134051-90-4",
"101931-68-4",
"101756-33-6",
"53230-10-7",
"19430-93-4",
"100482-67-5",
// more CasNumbers here
]
}
}GET Exemption Lists Index
/integration/exemption-lists
Retrieve all BOMcheck supported exemption lists including the list identity details (ExemptionsListID). Each list will contain the full schedule of exemptions applicable to that list and include the exemption "Identity" (e.g. "1(a)") and "Description" (e.g. "Mercury in single capped (compact) fluorescent lamps not exceeding (per burner):For general lighting purposes less than 30 W: 2.5 mg").
Payload Example
// URL: /integration/exemption-lists
{
"ExemptionsLists": [
{
"ExemptionsListID": {
"_identity": "EL2011/534/EU",
"_authority": "IPC"
},
"Exemptions": [
{
"Identity": "1(a)",
"Description": "Mercury in single capped (compact) fluorescent lamps not exceeding (per burner):For general lighting purposes less than 30 W: 2.5 mg"
},
{
"Identity": "1(b)",
"Description": "Mercury in single capped (compact) fluorescent lamps not exceeding (per burner):For general lighting purposes greater than or equal to 30 W and less than 50 W; 3.5 mg"
},
{
"Identity": "1(c)",
"Description": "Mercury in single capped (compact) fluorescent lamps not exceeding (per burner):For general lighting purposes greater than or equal to 50 W and less than 150 W; 5 mg"
},
// more Exemptions here
]
},
// more ExemptionsLists here
]
}GET Suppliers Index
/integration/suppliers
Retrieve all BOMcheck registered public suppliers including all publicly named contacts positioned at that supplier. Data includes "Name", "BOMcheckSupplierCode" (unique company DUNs number issued by Dun & Bradstreet), address information and "Contacts" (array of available contacts at the supplier).
Payload Example
// URL: /integration/suppliers
{
"Suppliers": [
{
"Name": "supplierCompanyName",
"BOMcheckSupplierCode": "111111110",
"Website": "supplierCompanyWebsite.com",
"Phone": "111111111110",
"Building": "supplierCompanyBuilding",
"Street": "supplierCompanyStreet",
"City": "supplierCompanyTown",
"StateProvince": "supplierCompanyCountry",
"Country": "GB",
"PostalCode": "ba11hj",
"Contacts": [
{
"Name": "supplierFirstName supplierLastName",
"Title": "supplierManagerPosition",
"Email": "supplier@bomcheck.net",
"ExpiryDate": "2031-12-30"
},
// more Contacts here
]
},
// more Suppliers here
]
}Response Output
?output={content||file}
All Integration Data endpoints accept an optional output query parameter to instruct the returned data to be issued as either a content or file download response.
- Type: String
- Description: Specifies the behaviour of the response type to either trigger a file download or return the content directly in the response.
- Required: No
- Default: "content"
- Valid Values: "content", "file"
- Example:
/integration/suppliers?output=file