CorpVerify
Default Flow
Result Delivery
Retrieval Methods
Try It Out
Client ID in x-client-id header.
Client Secret in x-client-secret header.
Name of the company
Company ID (e.g., BRN for Hong Kong, ACN for Australia)
The document type to retrieve. Must match a name (or alias) from the country's documentTypes list in /cra/info.
If omitted, defaults to the country's defaultDocumentType from /cra/info (unless a specific documentId is provided).
Year of the document - only provide it if the retrieval requires it
Specific document ID - if provided, it is prioritized over "documentType" and "documentYear"
Set to true to test the full request-poll flow without incurring costs.
A sample PDF is uploaded to S3 and the request returns immediately.
Optional field for usage analytics
Your own reference ID (optional field for usage analytics)
Expediate request speed (Only used if turn-around times have been agreed upon)
HTTPS URL to receive a webhook POST when the report is ready.
When provided, the completed report (same payload as a 200 response from /cra/poll)
is delivered to this URL.
Polling remains available as a fallback.
^https://.+Successfully initiated the request
JWT token that encodes the request details and should be used in the /cra/poll endpoint to check the status and retrieve the document
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIn0.dozjgNryP4J3jVmNHl0w5N_XgL0n3I9PlFUP0THsR8UEchoed back as true when the request was a dry run — no cost incurred
Bad Request - Unsupported country code, Document not available for the specifiic company, or sample not available
Internal server error
Client ID in x-client-id header.
Client Secret in x-client-secret header.
JWT token
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIn0.dozjgNryP4J3jVmNHl0w5N_XgL0n3I9PlFUP0THsR8UPattern: ^[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]*$Report is ready
Report is still being processed
Bad Request - Invalid input parameters
Internal server error
Client ID in x-client-id header.
Client Secret in x-client-secret header.
Company name to search (English or Chinese)
Page of results to return. Pagination support varies by country — for countries where it is not supported, only the first N results are returned regardless of this value. Check meta.page in the response to confirm whether pagination was applied.
1Successfully retrieved matching companies
Response message
Bad Request - Unsupported country code or search not implemented
Too many results - search term is too broad
Internal server error
Client ID in x-client-id header.
Client Secret in x-client-secret header.
Company ID (e.g., BRN for Hong Kong, ACN for Australia)
Optional filter by document type. (Country Specific)
- HK: financialStatement, annualReturn
- PH: GIS, AFS
- GB: Specific filing type codes (e.g. CS01, AA, AR01, AP01, TM01, SH01, MR01) or
category names (e.g. accounts, officers, confirmation-statement). Specific codes
are the primary interface and match the
documentNamevalues returned by this endpoint and thedocumentTypeaccepted by/cra/request.
Optional filter by year
Page of results to return. Check meta.totalPages in the response to determine total pages available.
1Successfully retrieved documents as a flat array
Status of the operation
Bad Request - Unsupported country code or search not implemented
Internal server error
Client ID in x-client-id header.
Client Secret in x-client-secret header.
Company ID (e.g., BRN for Hong Kong, ACN for Australia)
Successfully retrieved company information
Status of the operation
Company base information object or null if not found
Bad Request - Unsupported country code or search not implemented
Internal server error
Client ID in x-client-id header.
Client Secret in x-client-secret header.
ISO 3166 alpha-2 country code (e.g. HK). Case insensitive.
Successfully retrieved country information
Bad Request
Internal server error
Last updated

