Skip to main content

Documents API

Updates

System maintenance

21 October 2025General

On 26 October we will do some system maintenance that will affect our APIs. You might experience some outage between 07:00 and 09:00 Sunday 26 October.

Analytics - new documents API

3 December 2024 Important

A new API has been added for document search. First version of this API supports search and download of customs documents. These documents are the same that can be accessed in Mybring web in the documents/customs section.

API doc can be found here: https://developer.bring.com/api/documents/

Older updates

Important Update! New TLS certificates on api.bring.com 27th of October 2025

26 September 2025General

Migration from Buypass to Let’s Encrypt TLS Certificates As of 15 September 2025, Buypass has stopped allowing registration of new ACME Account and will stop generating/renewing TLS certificates from 15th October 2025. To ensure continuity, we are migrating all TLS certificates from Buypass to Let´s Encrypt.

As part of this activity:

  • Old Buypass certificates will be removed
  • New Let´s Encrypt certificates will be created

Impact to Customers:

  • If your application does not pin the certificate, no action is required and there will be zero impact.
  • If your application does pin the certificate, you will need to download the new Let´s Encrypt certificate and update your application configuration accordingly.

We recommend reviewing your applications to check whether certificate pinning is in place and preparing for updates if needed.

For more queries, contact integrasjon.norge@bring.com (Norway) or edi@bring.com (outside Norway).

Note! Removal of temporary domain api-new.bring.com

11 January 2023General

From 19 January 2023, APIs hosted on api-new.bring.com will stop working. Please start using api.bring.com instead of api-new.bring.com.

For more queries contact to integrasjon.norge@bring.com (Norway) or edi@bring.com (outside Norway).

Upcoming DNS change 1st of April 2022

21 December 2021General

Bring’s applications and infrastructure are going through bigger changes, as part of modernizing our infrastructure. One of these changes, is update of our load balancing component, and that will affect services running on api.bring.com. Be sure to verify your integration before the change to ensure no service disruption.

EDI documentation

8 June 2021General

New versions of the documents Appendix2 Available Services and Appendix 2A Instructions for service Implementation

The Documents API can be used to fetch documents related to your shipments.

Authentication

To integrate with the Bring APIs, you will need a Mybring user account with an API key. Information about prerequisites and authentication headers can be found on the general API Getting Started page.

Format

REST JSON over HTTP when searching for documents. The documents contains JSON or PDF.

Document types

The only type of documents that are currently available in the API are customs documents. These are the same that can be found customs document section in Mybring web. There exists both JSON and PDF variants of most customs declaration documents.

Endpoints

Base URL
https://www.mybring.com/document-search
Usage Method Endpoint
Search for documents GET /api/v1/search/{customerNumber}
Fetch document by id GET /api/v1/document/{customerNumber}/{id}

Search for documents

GET
https://www.mybring.com/document-search/api/v1/search/{customerNumber}

Customer number must be set and at least one of the other search parameters. Max range for date interval search is 100 days

Request

path parameters

customerNumber
Required
Type
string

query parameters

customsDeclarationNumber
Type
string
orderNumber
Type
string
shipmentNumber
Type
string
packageNumber
Type
string
dateArchivedFrom
Description
Date format: yyyy-MM-dd
Type
string
Example
dateArchivedFrom=2024-10-01
dateArchivedTo
Description
Date format: yyyy-MM-dd
Type
string
Example
dateArchivedTo=2024-10-30

Responses

200 Successfully provided document ids for the given search

Schema

Media type: application/json

Required
array of objects
consignmentItemNumbers
array of strings
string
consignmentNumber
string
customerNumber
Required
string
customsNumber
string
docType
Required
string
filename
Required
string
id
Required
string
orderDate
string <date>
packageNumber
Required
string
shipmentNumber
Required
string
uploadedDate
Required
string <date>

Response examples

{
  "documents": [
    {
      "customerNumber": "123456789",
      "docType": "JSON",
      "filename": "filename.json",
      "id": "4321-8765-json-4321",
      "orderDate": "2024-01-01",
      "packageNumber": "370123456789",
      "shipmentNumber": "123456789",
      "uploadedDate": "2024-01-01"
    },
    {
      "customerNumber": "123456789",
      "docType": "pdf",
      "filename": "filename.pdf",
      "id": "1234-5678-pdf-1234",
      "orderDate": "2024-01-01",
      "packageNumber": "370123456789",
      "shipmentNumber": "123456789",
      "uploadedDate": "2024-01-01"
    }
  ]
}

Fetch document by id

GET
https://www.mybring.com/document-search/api/v1/document/{customerNumber}/{id}

Fetch document by id for a given customer number.

Request

path parameters

customerNumber
Required
Type
string
id
Required
Type
string

header parameters

Accept
Description
Documents are either of type PDF or JSON. Allowed accept headers are application/json and application/pdf or just accept all.
Type
any
Example
Accept=*/*

Responses

200 Successfully returned document by id.
comments powered by Disqus