Introduction

📄️ Data flow

PrimaryBid Connect API facilitates bi-directional communication between PrimaryBid's services and external API client(s).

📄️ Onboarding process

All Partners are provided with onboarding support to get started with PrimaryBid integrations.

📄️ Authentication

Inbound requests directed to all PrimaryBid Connect API services and endpoints are governed through the following authentication methods:

📄️ Getting started

Take our API for a spin! Send your first PrimaryBid Connect API request. By following a few steps, you can perform an API call and receive a response in less than 3 minutes. Ready?

📄️ Webhooks

We recommend the use of our webhooks to notify API clients of specific events.

📄️ Rate limits

To ensure high levels of service for all users of the PrimaryBid Connect API we apply usage limits to our APIs.

Our API follows a common industry standard called idempotency. Idempotent means that no matter if you make one or multiple successive requests, you receive the same response from the server. The result is different only if the resource data on the server was updated in the meantime. It’s the same as multiplying a number by zero - the result is still zero.

📄️ Request and response formats

Request format

📄️ Error handling

Endpoint error response

📄️ Pagination

To allow our API partners to efficiently retrieve higher volumes of applications, we support pagination for offers, subscriptions, and allocations. This means we’re dividing a large set of data into smaller, manageable batches. Instead of retrieving all the data in a single response, the API returns just a small subset and users can subsequently poll for additional pages.

📄️ Data and security

PrimaryBid uses best-in-class observability and security tools and measures to maintain the highest level of protection against API misuse and cyberattacks. Our security practices ensure that:

📄️ Performance and reliability

A surefire way of connecting retail clients with primary market offers in a dynamic, digital-first ecosystem, is adopting a scalable and highly-performant API.

📄️ Glossary

This section of the PrimaryBid Connect API documentation explains a few essential concepts required to fully understand the design and function of the API. We organised the terms by domain and particularity, starting with the main PrimaryBid Connect API notions, and continuing with Financial and Technical terminology.

📄️ FAQs

How do allocations take place when we send subscriptions to the test server?

📄️ Introduction