CNAM API Documentation

Welcome to the CNAM API documentation. This API provides endpoints to interact with the CNAM backend services.

Swagger UI ReDoc UI Swagger JSON

Overview

The CNAM API provides the following main features:

API Endpoints

Eligibility Check

Check if a person is eligible as a beneficiary.

GET /api/cnam/check-eligibility/

Parameters: id_dossier, num_cin, or inam (at least one required)

Beneficiaries

Get list of beneficiaries for a dossier.

GET /api/cnam/beneficiaries/

Parameters: id_dossier, num_cin, or inam (at least one required)

Beneficiary Detail

Get detailed information about a beneficiary.

GET /api/cnam/beneficiary-detail/

Parameters: id_dossier, num_cin, or inam (at least one required)

Adhesions

Get list of adhesions for a dossier.

GET /api/cnam/adhesions/

Parameters: id_dossier, num_cin, or inam (at least one required)

Attestation Generator

Generate an attestation PDF.

GET /api/cnam/attestation/

Parameters: id_dossier, num_cin, or inam (at least one required)

Beneficiary ALD List

Get list of ALDs for a beneficiary.

GET /api/cnam/beneficiary-ald-list/

Parameters: patient_id (required)

ALD Attestation Generator

Generate an ALD attestation PDF.

GET /api/cnam/ald-attestation/

Parameters: patient_id (required), ald_id (optional)

Doctors List

Get paginated list of doctors (prescribers) with optional search.

GET /api/cnam/doctors/

Parameters: search (optional), page (optional), page_size (optional)

Create Declaration

Create a new declaration with document upload.

Note: For NEWBORN and NEWPARTNER types, target_nni is validated against ANRPTS database.

NNI Format: All NNI fields (assured_nni, target_nni) must be exactly 10 digits (e.g., "0123456789").

POST /api/cnam/declarations/create/

Parameters: assured_nni (required, 10 digits), target_nni (required, 10 digits), type (required), document (required - PDF only), issued_date (optional), id_presc (optional)

List Declarations

Get paginated list of declarations with search and filtering options.

NNI Format: All NNI fields must be exactly 10 digits for searching and filtering.

GET /api/cnam/declarations/

Parameters: search (optional), assured_nni (optional, 10 digits), target_nni (optional, 10 digits), type (optional), is_handled (optional), issued_date (optional), page (optional), page_size (optional)

Interactive Documentation

For complete API documentation with interactive testing capabilities, please visit our Swagger UI:

Explore the API with Swagger