Enrich Companies (start)
Endpoint: POST /v2/companies/enrich
201 – Created
What it means: Your enrichment request was received and is being processed.
Next steps: Use the returned
enrichmentIDto check the status using the GET endpoint.
400 – Invalid Request
What it means: Some required information is missing or incorrectly formatted.
Next steps: Double-check your request data. Make sure you're following the format shown in the API documentation. Each company must have a valid domain and the request cannot exceed 500 companies.
401 – Unauthorized
What it means: Your API key is missing or invalid.
Next steps: Confirm you've included a valid API key in the request headers.
402 - Not Enough Credits
What it means: Your account does not have enough search credits to complete this request.
Next steps: Check your search credit balance via the Get Credits endpoint (
GET /v1/credits). To enable or top up search credits contact api.support@surfe.com.
403 – Forbidden
What it means: The request cannot be handled because it would either exceed your daily quota or there are not enough credits available.
Next steps: Check your credit balance via your Surfe dashboard or the Get Credits endpoint. If you've hit your daily quota, wait until midnight for it to reset. If you need higher limits or are unsure what's causing this, contact our support team via Intercom and we'll help you out.
500 – Internal Server Error
What it means: Something went wrong on our side.
Next steps: Wait a moment and try again. If the issue continues, reach out to the support team via Intercom.
Enrich Companies (get)
Endpoint: GET /v2/companies/enrich/{id}
200 – Success
What it means: Your company enrichment results are ready.
Next steps: Review the returned data and use it as needed.
400 – Invalid Request
What it means: The request is not properly formatted.
Next steps: Ensure the
enrichmentIDis correct and follows the API format.
401 – Unauthorized
What it means: Your API key is missing or invalid.
Next steps: Verify that your API key is included and active.
403 – Forbidden
What it means: The request cannot be handled because it would either exceed your daily quota or there are not enough credits available.
Next steps: Check your credit balance via your Surfe dashboard or the Get Credits endpoint. If you've hit your daily quota, wait until midnight for it to reset. If you need higher limits or are unsure what's causing this, contact our support team via Intercom and we'll help you out.
500 – Internal Server Error
What it means: Something went wrong on our side.
Next steps: Try again shortly. If the problem persists, contact support via Intercom.
If you're ever unsure about an error or how to fix it, our team is here to help. Reach out to the support team via Intercom.
Comments
0 comments
Please sign in to leave a comment.