Skip to main content

API Match Overview

This document describes the functional flow of integrating with the Match API, which is a set of REST APIs designed to process and retrieve profiles accordingly to a job position. It includes the B2B integration flow, API usage, synchronous processing logic, and the data models returned by the system.

Flow Summary​

The Match flow is synchronous and designed to scale. It includes the following key steps:

1. Authentication:​

  • The API supports M2M Authentication (B2B) for backend systems and integrations, using pre-provisioned credentials (e.g., client ID and secret) to obtain a JWT token for API access.
  • The token must be included in the Authorization: Bearer <token> header of each request.

2. Profiles:​

  • Endpoint: GET /direct-search
  • Clients retrieve profiles via this endpoint.
  • The API returns a list of profiles that matches all input criteria ranked by scores.

Sequence Diagram​

The sequence diagram below outlines how external systems interact with the BeTalent CV Screening API. After authentication, the client can use the JWT token to call the API.