Integration Guide

Everything needed to integrate with the PDA API ecosystem in one place.

Use this portal to understand authentication, environments, shared conventions, service coverage, endpoint contracts, and the key schemas required for implementation.

Explore endpoints Review schemas
23

curated endpoints reorganized by integration use case

7

service groups with a consistent contract narrative

1

single place for onboarding, standards, contracts, and go-live checks

Overview

Integration overview

This portal centralizes the information required to authenticate, select the correct environment, understand shared integration rules, and work with each available service.

Use the quick start to begin implementation, the conventions section for shared rules across services, the service map to identify the right API surface, and the endpoint reference for each contract.

How to use this guide

  • Start with authentication and environment selection
  • Apply shared headers and language conventions across requests
  • Find the service that matches your business flow
  • Validate payloads and responses in Swagger before go-live

Recommended flow

Recommended integration flow

This sequence summarizes the most common client journey: authenticate, identify the client scope, invite the individual, validate the assessment, generate the report, and optionally receive webhook notifications.

Onboarding

Quick start flow

Shared rules

Integration conventions

Report response behavior

Classic report endpoints can return either a downloadable file URL or a JSON payload depending on reportFormat.

  • PDF / DOC: short-lived URL
  • XLSX: short-lived URL
  • JSON: contract object defined by the service schema

Map

Service landscape

Contracts

Endpoint reference

Identity Service

Authentication and access

POSTLogin/api/identity/v1/Users/Login GETGet Accounts Access List for User/api/identity/v1/Accounts/AccountSubBaseDetail

Credit Service

Credit visibility

GETReturn All Credit Movement for the Current User/api/credit/v1/Credit/CreditConsumeMovement GETReturn Credit Balance Detail by Client/api/credit/v1/CreditBalance/base/{baseId}

Report Service

Classic reports and generated outputs

POSTGenerate Classic PDA Report/api/report/v1/ClassicReports/PDAAssessment POSTGenerate Classic Competency Report/api/report/v1/ClassicReports/CompetencyReport POSTGenerate Classic Job Report/api/report/v1/ClassicReports/JobReport POSTGenerate Invalid PDA Assessment Report/api/report/v1/ClassicReports/InvalidPDAAssessment GETGet Link Summary Review/api/report/v1/ReportGenerated/GetLinkSummaryReview

Job Service

Puestos y compatibilidades

GETGet Jobs/api/job/v1/Jobs POSTGet Individuals-Job Compatibility/api/job/v1/Jobs/GetIndividualsJobCompatibility

Competency Service

Competencies and compatibilities

GETGet Competencies/api/competency/v1/Competencies POSTGet Competency Compatibility/api/competency/v1/Competencies/Compatibility

Individual Service

Individuals and assessments

GETGet All Individuals with Behavioral Profile/api/individual/v1/Individuals/GetAllIndividualWithBehaviouralProfile POSTAdd Individual/api/individual/v1/individuals POSTRequest Evaluation/api/individual/v1/individuals/Invitation GETGet Evaluation Links/api/individual/v1/AssessmentConfiguration/GetLinks GETGet PDA Assessment Words/api/individual/v1/PDAAssessments/Words POSTEnter PDA Assessment/api/individual/v1/PDAAssessments GETObtain Individual Evaluations/api/individual/v1/PDAAssessments/IndividualEvaluations

Analytics Service

Exports and analytics datasets

GETGet All Analytics PDA Assessment/api/analytics/v1/PDAAssessment GETGet All Analytics Competency/api/analytics/v1/Competency GETGet All Analytics Job/api/analytics/v1/Job

Payloads

Schema highlights

These are the payloads integrators most often need to understand before implementation. Swagger remains the validation source of truth for exhaustive property coverage.

Operational readiness

Go-live checklist