API HTTP Status Codes

nCino follows standardised and well-established practices for HTTP status codes. Every API call will return a status code and a message with a description issued by our server in response to a client’s request. This article will help you to identify the root cause and the next steps to troubleshoot an error you have encountered.

Successful call

200  'SUCCESS'

• The request has succeeded. 

 

Client Error (4xx)

401  'UNAUTHORISED'  'Client is not authorised' or 401  'UNAUTHORISED'  'Access token is not authorised’ 

• This error message signifies that the user has failed to provide an authentication token (API Key) or the one provided is invalid. 
• Please check if the authentication token is passed correctly with the request (X-AUTH-TOKEN as a header parameter).

403 ‘FORBIDDEN’ ‘Access denied’ 

• This error message signifies that your API Key has insufficient access level for the requested information. You may be attempting to perform a request from a module you are not subscribed to.
• If you have any questions, please contact your Enterprise Relationship Manager or email us at [e-mail] to discuss your API Package.

400 ‘Invalid countryCode: \"__\", countryCodes must be lowercase and one of [gb, ie].’

• This message signifies that the queried country is currently not supported by FullCircl. Please ensure that you have entered the correct country code format and that it is entered in lower case.

429 'OVER_QPS_RATE' 'Maximum requests per second exceeded'

• This response signifies that your call limit has been reached. FullCircl offers a standard rate limit of 30 calls per second. We encourage you to optimise your code and adjust your application in line with the set QPS rate limit in your contract.
• Should you wish to discuss increasing the allowed throughput for the key, please get in touch with your Enterprise Relationship Manager or email us at [e-mail].

429 ‘CALLCREDIT_IDENTITY_CHECK_OVER_QUOTA’

429 ‘COMPANY_CHECK_OVER_QUOTA’

429 ‘CREDIT_REPORT_OVER_QUOTA’

429 ‘PEPS_AND_SANCTIONS_OVER_QUOTA’

• Any of the above 429s responses related to allowance signify that the given key was given an absolute call limit or premium endpoints have hit their quota limit.
• Should you wish to discuss increasing the allowed throughput for the key, please get in touch with your Enterprise Relationship Manager or email us at [e-mail].

405 'METHOD_NOT_ALLOWED'  'Endpoint does not support this HTTP method'

• Please ensure you are using the correct request type. For instance, if you are making a GET request for a POST request this error will occur. For more information, please refer to FullCircl API Documentation here.

404 'NOT_FOUND'  ‘There is no matching company record’

• The information you are requesting is not found. Please check that your path and query parameters are correct and the information provided is accurate (e.g. companyID). Please refer to our API Documentation here to verify the required format for each endpoint.
• If you are certain that the information provided and the parameters are correct and this response is unexpected, please contact us at [e-mail].

 

Server Error (5xx)

A 5xx response signifies a potential server error on nCino’s side, or an error in nCino failing to obtain a response from one of our suppliers. Please subscribe to our Status Page to stay up to date with the service availability.

503 ‘Service Unavailable’

500 ‘Internal Server Error’ 

504  ‘Gateway Timeout’ 

504 ‘Endpoint unavailable’

If you experience any of the aforementioned errors, please contact us at [e-mail] or reach out to your Enterprise Relationship Manager directly.