Pomanda Api
Company
Endpoints for company information
Company Details
Request
Method:
GET
EndPoint:
[DATA_SERVICE_API_ORIGIN]/v1/company/details/:reg
Header:
accesstoken: <AUTHENTICATION_TOKEN>
Parameters:
country: string (required). The country for the company search
reg: string (required). Company Registration Number
Response:
200 Success: The request was successful, and company 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
Directors
Request
Method:
GET
EndPoint:
[DATA_SERVICE_API_ORIGIN]/v1/company/directors/:reg
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 (required). Company registration number
currPrev: 'c', 'p' or null. Current or Prior directorships (null for all)
Response:
200 Success: The request was successful, and directors will be returned in the response body.
400 Bad Request: The request was malformed or missing required parameters.
401 Unauthorised: User Id & Password combination is not valid
Financials
Request
Method:
GET
EndPoint:
[DATA_SERVICE_API_ORIGIN]/v1/company/financials/:reg
Header:
accesstoken: <AUTHENTICATION_TOKEN>
Parameters:
country: string (required). The country for the company search
useEstimates: boolean or null. Include Pomanda estimated financial data
page: integer. Page number for pagination, with the default starting page number as 1
pageSize: integer. Number of items per page
reg: string (required). Company registration number
Response:
200 Success: The request was successful, and financials will be returned in the response body.
400 Bad Request: The request was malformed or missing required parameters.
401 Unauthorised: Token is not valid
Trading Locations
Request
Method:
GET
EndPoint:
[DATA_SERVICE_API_ORIGIN]/v1/company/locations/:reg
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 (required). Company registration number
Response:
200 Success: The request was successful, and locations will be returned in the response body.
400 Bad Request: The request was malformed or missing required parameters.
401 Unauthorised: Token is not valid
Charges
Request
Method:
GET
EndPoint:
[DATA_SERVICE_API_ORIGIN]/v1/company/charges/:reg
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 (required). Company registration number
open: boolean or null. If true, includes only open charges
Response:
200 Success: The request was successful, and charges data will be returned in the response body.
400 Bad Request: The request was malformed or missing required parameters.
401 Unauthorised: Token is not valid
