Response Codes

In addition to HTTP Codes, Kyckr supplies a code to provide additional information on the request response.

Response	Code	Endpoints	Scenario
SUCCESS	100	All	Request completed successfully
SERVER_ERROR	500	All	Unanticipated error
NO_RESULTS	102	Search, Filings	Search of source was successful, but result was an empty list
REGISTRY_NOT_AVAILABLE	104	All	Unable to connect to a registry that we can normally service
COMPANY_NOT_FOUND	105	Profile, Filings	Request was unsuccessful because the company does not exist
INVALID_REGISTRATION_AUTHORITY	106	Profile, Filings	The contents of the regAuth parameter were not valid
PARAMETER_NOT_SUPPORTED	107	All	The parameter included is not valid for this endpoint
TOO_MANY_MATCHES	109	Search, Filings	Search was unsuccessful because too many matches were returned
COMPANY_NUMBER_NOT_VALID_FORMAT	110	Number Search, Profile, Filings	The company number specified does not match the format expected for a particular jurisdiction
PRODUCT_NOT_AVAILABLE	111	All	The combination of ISO code and Product is not one that exists
INVALID_ARGUMENT	112	All	Invalid argument used
INSUFFICIENT_FUNDS	402	All	Account has insufficient funds to transact

The responseCodeField will be returned in the response for Search, Lite and Enhanced profiles as well as Fillings Search. There will not always be a responseCodeField if the result was successful. Successful responses can be treated as 100 - SUCCESS. If the result was unsuccessful, a responseCodeField will be present in the response.

Getting Started

Useful Information

Features

Platform Details