PrimaryBid Connect API is a RESTful API containing a set of HTTPS based resource-oriented URLs allowing PrimaryBid Partners to participate in PrimaryBid offers.
Our Developer Portal contains detailed documentation on our API data flow, authentication and security protocols, use cases, changelogs, and references to ensure the best developer and integration experience.
Use Cases
- Retrieve details of a PrimaryBid offer(s),
- Create subscriptions and automate retail investor participation,
- Retrieve details of all allocations for a PrimaryBid offer(s).
Integration Requirements
PrimaryBid Connect API requires Partners to:
- Set up a back-end integration to facilitate and automate two-way communication between PrimaryBid and the API client,
- Deploy a front-end interface (on their web/app platform) to display offer details, receive order submissions, and display allocation details,
- Develop external communication services such as SMS and email channels to notify retail investors of offer and allocation details.
Through the above, our API allows partners to private label PrimaryBid offers and completely customise the user experience for deal participation.
Please refer to Onboarding Process for more details on the API implementation.
Share Settlement Process
Following the completion of an offer, the settlement of shares occurs outside of the scope of the PrimaryBid Connect API.
Our Operations team will work with you to ensure this process is outlined and clarified.
Regional Access
PrimaryBid Connect API is region- and market-agnostic and caters to the Partners in all locations where we have a presence in (currently the UK and France).
API Standards
PrimaryBid Connect API is fully documented using the OpenAPI 3 standard.
POSTMAN Collection
PrimaryBid Connect API has also been documented in the form of a POSTMAN collection. Please reach out to a Solutions Engineer to obtain this.