Pomanda Api
Search
Endpoints for company & director search.
Company Search
Request
Method:
POST
EndPoint:
[DATA_SERVICE_API_ORIGIN]/v1/search/companies
Header:
accesstoken: <AUTHENTICATION_TOKEN>
Parameters:
page: integer. Page number for pagination, with the default starting page number as 1
pageSize: integer. Number of items per page
country: string (required). The country for the company search
reg: string or null. Company Registration Number
companyName: string or null. Name of the company
exact: boolean or null. If true, performs an exact name match
activeCompanies: boolean or null. If true, includes only active and not dormant companies
regPost: string or null. Registered postcode for the company. Can include wildcards *
Response:
200 Success: The request was successful, and companies will be returned in the response body.
400 Bad Request: The request was malformed or missing required parameters.
401 Unauthorised: Token is not valid
Director Search
Request
Method:
GET
EndPoint:
[DATA_SERVICE_API_ORIGIN]/v1/search/directors
Header:
accesstoken: <AUTHENTICATION_TOKEN>
Parameters:
page: integer. Page number for pagination, with the default starting page number as 1
pageSize: integer. Number of items per page
country: string (required). The country for the company search
pnr: string or null. Unique director id
firstName: string or null. First name of the director
lastName: string or null. Last name of the director
ageMin: integer or null. Minimum age of director
ageMax: integer or null. Maximum age of director
companyName: string or null. Company name associated with director
open: boolean or null. If true, includes only open directorships
Response:
200 Success: The request was successful, and director details will be returned in the response body.
400 Bad Request: The request was malformed or missing required parameters.
401 Unauthorised: Token is not valid
