Skip to main content

API Integration Overview

This document describes the functional flow of integrating with the CV Screening API, which is a set of REST APIs designed to process and retrieve CV data. It includes the B2B integration flow, API usage, asynchronous processing logic, and the data models returned by the system.

Flow Summary​

The CV Screening flow is asynchronous 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.
  1. Upload CV:
  • Endpoint: POST /cv-screening/upload-cv
  • Clients submit CV documents via this endpoint.
  • The API returns an invocationId that can be used to track and retrieve the processing results.
  1. Processing:
  • The system processes the CV asynchronously, including:
    • CV parsing and entity extraction.
    • Saliency scoring and enrichment.
    • Photo extraction from the uploaded CV.
  • Results are made available for retrieval once the processing is complete.
  1. Result Retrieval:
  • Endpoint: GET /cv-screening/{invocationId}
  • Clients poll for processed results using their invocationId that was returned after the upload.

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.

You can view and edit the sequence diagram interactively on the Mermaid Live Editor.