Verify a guarantee

Verify Guarantee Endpoint

The GET /verify endpoint is designed to confirm the authenticity of a guarantee by verifying several key attributes provided as query parameters. This verification process helps in ensuring that the details of a guarantee match the records stored within the system.

HTTP Request

GET /api/v1/verify

Query Parameters

ParameterTypeDescriptionRequired
checksumstringThe checksum of the file to be verified.Yes
cigstringYes
contractorVatNumberstringThe VAT number (Partita Iva) of the contractor.Yes
garantedAmountstringThe amount of the guarantee.Yes
guaranteedVatNumberstringThe VAT number (Partita Iva) of the guaranteed party.Yes
idstringThe unique identifier of the guarantee to be verified.Yes

Description of Parameters

  • Checksum: A unique string generated by the system to validate the integrity and authenticity of a guarantee.
  • CIG (Codice Identificativo Gara): This is a unique identifier used primarily in public procurement to track individual contracts.
  • Contractor VAT Number (Partita Iva): This is the VAT registration number of the contractor, a crucial identifier in financial and contractual documents.
  • Guaranteed Amount: The financial amount covered by the guarantee, expressed in the appropriate currency.
  • Guaranteed VAT Number (Partita Iva): The VAT registration number of the entity receiving the guarantee.
  • ID: The system-generated unique ID assigned to the guarantee upon creation.

Response

This endpoint always returns a HTTP status code 200, indicating that the API successfully processed the request, regardless of whether the verification is successful.

Response Structure

{ "message": "success", "data": { "verified": false } }