All Yasmina API responses are in JSON format. Responses with code 204 will not have a body. Below is the common data types that we use throughout our API
Data TypeFormat / Description
DatetimeISO 8601 format, e.g., 2025-08-05T13:30:00Z
DateISO 8601 date format, e.g., 2025-08-05
CountryISO 3166-1 alpha-2 code, e.g., SA
Client IDUUID format, e.g., 123e4567-e89b-12d3-a456-426614174000
Client SecretA random string. This will be hashed in our databases for enhanced security
IDYasmina internal identifier, this will be an integer
Provider Policy IDPolicy ID that is provided by Insurance company
Provider PolicyA file URL (Usually in PDF)
Cancellation DocumentA file URL (Usually in PDF)