Getting Started with Hirize

Securely access Hirize’s AI document processing with API keys. This section covers obtaining your API key, integrating it into requests, and setting up webhooks.

Hirize uses API keys to authenticate your requests. You can securely interact with our API endpoints by including your api_key as a query parameter.

Our parser supports all document formats (PDF, JPG, PNG and more) it includes OCR capabilities, enabling precise data extraction across diverse workflows.

---

Obtaining Your API Key

1. Create an Account Register at https://app.hirize.hr/ register by providing the necessary information. Upon registration, your organization is automatically created for you.

2. Generate API Key After logging in, navigate to the </> End Points page on your dashboard. Next click the Generate a new API Key button.

3. API Endpoint Key Once you're at the New End-point page; 1. Give the Endpoint you want to create a name e.g Hirize HR parser 2. Webhook URL you can insert # 3. Select the API end-point you would like to use from the dropdown. e.g Hirize Fin (invoice parser) 4. Hit create endpoint and copy the key Once generated, copy and securely store your API key, as it will be required for all API interactions.

Go to end-points page

Create Key

Using Your API Key

*Make sure you have a Postman account if you do not have one create one here: POSTMAN https://www.postman.com/

Head to documentation, you can find the link here too: DOCUMENTATION

1. Select Run in Postman and select Postman for Web, you will then select your workspace and hit import.

Run in postman and select postman for web

Select workspace and hit import

Make sure you've selected the public environment and authenticate your API requests!

1. To authenticate your API requests, include your API key as a query parameter in each request. Make sure you hit Save!

1. Replace <Your_API_Key> with the API key you generated in the previous step and hit SEND to finish your setup

Best Practices

• Use Environment Variables: Store your API keys in environment variables rather than hardcoding them in your applications.

• Keep It Secure: Treat your API key like a password. Do not share it publicly or expose it in client-side code.

• For each product add the KEY under each product

• If you want to integrate on code level Here's a basic example using curl Replace <Your_API_Key> with the API key, for more on integrating on code level see: Backend codes and tools under the Extraction details tab

curl -X GET "https://api.hirize.hr/parse?api_key=YOUR_API_KEY" -H"Content-Type: application/json"