Description of the interface

The Candidate Applications Import API is a REST API accepting JSON payloads over HTTPS. All requests must be authenticated with a Bearer token — see the Authentication page.

• Only HTTPS is supported
• All request and response bodies use Content-Type: application/json
• Base URL: https://integrations-api.teamio.com

Communication flow

Endpoints

POST /api/v1/candidate-reactions

Submits a candidate application asynchronously. Attachments and the optional GDPR consent document are included inline as base64 content. Returns a UUID for status tracking.

• Content-Type: application/json
• Authorization: Bearer token obtained using your Production credentials
• Response: 200 OK with { "requestUuid": "<uuid>" }

POST /api/v1/candidate-reactions/test

Validates the request payload without saving anything. Use this in a sandbox/testing environment to verify your integration before going live. Uses exactly the same request format as the production endpoint.

• Content-Type: application/json
• Authorization: Bearer token obtained using your Sandbox credentials
• Response: 204 No Content (if valid)

GET /api/v1/candidate-reactions/{requestUuid}

Polls the processing status of a previously submitted candidate reaction. Replace {requestUuid} with the UUID returned by the POST endpoint.

• Authorization: Bearer token obtained using your Production credentials
• Response: 200 OK with the status object (see API Responses)