Skip to main content
NEXCLARADocumentation

applications

Dossiers de credit : saisie, soumission au moteur, evaluation, explication, reconstitution.

Descriptions come from the contract, which is written in French. They are reproduced verbatim so that the contract remains the source of truth.

GET /api/v1/applications

Liste de travail

Dossiers de l'institution, les plus recemment modifies d'abord.

applicationsList

Parameters

ParameterLocationTypeRequiredConstraints
statusquery"draft" | "submitted" | "escalated" | "decided" | nullno
product_idquerystring (uuid) | nullno
searchquerystring | nullnominLength: 2 ; maxLength: 64
minequerybooleannodefault: false
sortquery"updated_desc" | "score_desc" | "score_asc"nodefault: "updated_desc"
limitqueryintegernominimum: 1 ; maximum: 200 ; default: 25
offsetqueryintegernominimum: 0 ; maximum: 100000 ; default: 0

Request body

No request body.

Responses

StatusDescriptionContent typeType
200Successful Responseapplication/jsonApplicationPageOut
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v1/applications

Creer un dossier

Brouillon ; le montant et la duree sont requis des la creation.

applicationsCreate

Parameters

No parameters.

Request body

Content type
application/json
Type
ApplicationCreateIn
Required
yes

Responses

StatusDescriptionContent typeType
201Successful Responseapplication/jsonApplicationDetailOut
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v1/applications/{application_id}

Un dossier

Saisie, completude, politique et evaluations.

applicationsGet

Parameters

ParameterLocationTypeRequiredConstraints
application_idpathstring (uuid)yes

Request body

No request body.

Responses

StatusDescriptionContent typeType
200Successful Responseapplication/jsonApplicationDetailOut
422Validation Errorapplication/jsonHTTPValidationError

PUT /api/v1/applications/{application_id}

Enregistrer la saisie

Remplace la saisie d'un brouillon (concurrence optimiste).

applicationsUpdate

Parameters

ParameterLocationTypeRequiredConstraints
application_idpathstring (uuid)yes

Request body

Content type
application/json
Type
ApplicationUpdateIn
Required
yes

Responses

StatusDescriptionContent typeType
200Successful Responseapplication/jsonApplicationDetailOut
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v1/applications/{application_id}/applicant-history

Historique du demandeur

Autres dossiers du meme demandeur : recommandations, scores et decisions.

applicationsApplicantHistory

Parameters

ParameterLocationTypeRequiredConstraints
application_idpathstring (uuid)yes

Request body

No request body.

Responses

StatusDescriptionContent typeType
200Successful Responseapplication/jsonApplicantHistoryOut
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v1/applications/{application_id}/decision

Decider d'un dossier evalue

Responsable credit, dans sa delegation ; tout ecart exige un motif code et redige.

applicationsDecide

Parameters

ParameterLocationTypeRequiredConstraints
application_idpathstring (uuid)yes

Request body

Content type
application/json
Type
HumanDecisionIn
Required
yes

Responses

StatusDescriptionContent typeType
201Successful Responseapplication/jsonHumanDecisionOut
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v1/applications/{application_id}/escalation

Transmettre au niveau de delegation superieur

Seulement si le montant depasse la delegation de la personne.

applicationsEscalate

Parameters

ParameterLocationTypeRequiredConstraints
application_idpathstring (uuid)yes

Request body

Content type
application/json
Type
RowVersionIn
Required
yes

Responses

StatusDescriptionContent typeType
201Successful Responseapplication/jsonHumanDecisionOut
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v1/applications/{application_id}/evidence

Exporter le dossier de preuve d'un dossier evalue

Dossier de preuve `nexclara-decision-evidence@2` (ADR-0051). Memes droits que la lecture du dossier ; points de grille et references d'audit selon `scorecard.read` et `audit.read`. L'export est consigne au journal d'audit avec l'empreinte de son manifeste. Les octets sont servis tels quels : les reformater invaliderait la verification.

applicationsExportEvidence

Parameters

ParameterLocationTypeRequiredConstraints
application_idpathstring (uuid)yes

Request body

No request body.

Responses

StatusDescriptionContent typeType
200Fichier de preuve canonique, a verifier hors du service.application/jsonEvidenceBundleOut
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v1/applications/{application_id}/reevaluation

Reevaluer sous la politique devenue applicable

Nouvelle evaluation liee a la precedente ; entrees figees, statut inchange.

applicationsReevaluate

Parameters

ParameterLocationTypeRequiredConstraints
application_idpathstring (uuid)yes

Request body

Content type
application/json
Type
RowVersionIn
Required
yes

Responses

StatusDescriptionContent typeType
200Successful Responseapplication/jsonApplicationDetailOut
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v1/applications/{application_id}/submit

Soumettre au moteur de decision

Evaluation sous la politique en vigueur, enregistree et immuable.

applicationsSubmit

Parameters

ParameterLocationTypeRequiredConstraints
application_idpathstring (uuid)yes

Request body

Content type
application/json
Type
RowVersionIn
Required
yes

Responses

StatusDescriptionContent typeType
200Successful Responseapplication/jsonApplicationDetailOut
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v1/desk/products

Produits ouverts a la saisie

Produits actifs regis par une politique en vigueur.

deskProducts

Parameters

No parameters.

Request body

No request body.

Responses

StatusDescriptionContent typeType
200Successful Responseapplication/jsonarray<DeskProductOut>

GET /api/v1/desk/products/{product_id}/form

Formulaire de saisie d'un produit

Champs du contrat de donnees de la politique en vigueur.

deskProductForm

Parameters

ParameterLocationTypeRequiredConstraints
product_idpathstring (uuid)yes

Request body

No request body.

Responses

StatusDescriptionContent typeType
200Successful Responseapplication/jsonApplicationFormOut
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v1/evaluations/{evaluation_id}

Une evaluation

Evaluation enregistree, trace et trois niveaux d'explication.

evaluationsGet

Parameters

ParameterLocationTypeRequiredConstraints
evaluation_idpathstring (uuid)yes

Request body

No request body.

Responses

StatusDescriptionContent typeType
200Successful Responseapplication/jsonEvaluationOut
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v1/evaluations/{evaluation_id}/reconstitution

Reconstituer une evaluation

Refait le calcul et compare les empreintes ; l'acte est consigne a l'audit.

evaluationsReconstitute

Parameters

ParameterLocationTypeRequiredConstraints
evaluation_idpathstring (uuid)yes

Request body

No request body.

Responses

StatusDescriptionContent typeType
200Successful Responseapplication/jsonReconstitutionOut
422Validation Errorapplication/jsonHTTPValidationError