Skip to main content
​
DocsAPIs
Every error now has its own code. The Errors page lists the errors any endpoint can return, then the ones specific to each product, with the message and the reason for each. Cases that used to share 40000 are told apart: no OTP requested yet (40001), car or owner not verified by Yakeen (40002, 40003, 40004), phone not the owner’s or already in use (40005, 40006), unknown quote request, quote, price or benefit (40007, 40008, 40009, 40011), IBAN refused (40013), photo problems (40014, 40015), the insurer’s own refusal (40016), and a policy that cannot be cancelled yet (40017). SME medical rules have theirs too: a company with no employees (40020), declarations on a policy the insurer already issued (40021), an ids_or_emails entry naming nobody (40022). 422 is reserved for field validation and is always 42201; the medical rules that used to answer 422 answer 400 now. code is always a JSON string now; a few responses used to send a number. Every error is JSON with a code whatever the Accept header says: business-rule rejections and rate limits used to come back as an HTML page or a bare message. POST /api/v1/car-comp/issue-otp answers 400 instead of 200 when the quote request belongs to another client. An unreachable insurer is 504 / 50401, not 502. Rate limits are enforced as described on the rewritten Rate limiting page: 120 reads, 60 writes and 30 issue-type calls a minute per client, answered with 429 / 42901 and retry_after_seconds when exceeded.
​
DocsAPIs
Added the Guideline Texts API (GET /api/v1/car-comp/guideline-texts): the copy to show alongside motor quotes — the provider attribution with its Insurance Authority licence, the support routes, and the buyer FAQ — returned in English and Arabic together. Fetch it rather than hard-coding the wording, so changes reach you without an integration change.
​
DocsAPIs
Added the Upload Vehicle Photos API (POST /api/v1/car-comp/quote-requests/{id}/attachments): the five vehicle photos (front, back, right, left, chassis) required for comprehensive cover, sent as file uploads with the selected quote_price_id. Call it before requesting the payment OTP — the insurance provider downloads and checks every image during the call, so an unreadable photo is rejected while the customer can still retake it. All five are required together, JPG or PNG up to 3 MB each, and the photos can only be submitted once per vehicle.
​
DocsAPIs
Moved the iban field from the Issue Policy API to the Issue OTP API (POST /api/v1/car-comp/issue-otp), where it is now required. The customer’s Saudi IBAN (SA followed by 22 digits) is forwarded to the insurance provider with the payment OTP request and used for claim settlements and refunds. POST /api/v1/car-comp/policies no longer accepts the field.
​
DocsAPIs
Added the optional iban field to the Issue Policy API (POST /api/v1/car-comp/policies): the customer’s Saudi IBAN (SA followed by 22 digits) that insurance providers use to transfer claim settlements and refunds. Sending it is strongly recommended; when omitted, payouts are routed through a Yasmina fallback account, which can delay refunds to the customer.
​
DocsAPIs
Documented TPL Motor Insurance policy cancellation document validation. Cancellation requests now require an updated vehicle information document that matches the policy VIN and sequence number, and confirms that ownership transfer is complete. Added the new 422 cancellation document mismatch response to the TPL Motor Insurance API reference. Removed the unused TPL Motor Insurance v1 API reference from the API Reference navigation.
​
Docs
Added otp as a required field to the Request Quotes API (POST /api/v1/car-comp/quote-requests) and Issue Policy API (POST /api/v1/car-comp/policies) documentation. The field was already required by the backend but was missing from the docs and API reference.
​
DocsAPIs
Added company_logo_url and square_company_logo_url to motor quote responses so clients can display both the standard company logo and square logo from the CDN. Added the optional Accept-Language: ar header to the Car Insurance Request Quotes API for Arabic-localized quote content.
​
DocsAPIs
Added support for custom_number as an alternative to car_sequence_number in car quote requests. The custom_number is used for newly imported cars and must be between 1000000 and 9999999999.
​
DocsAPIs
Add start_date to the Car Insurance Issue Policy API documentation
​
Docs
Seperated Products between Multi Providers and Single Provider
​
Docs
Added Payment section to Motor Insurance
​
Docs
Documentation Revamp Added more sections
  • Changelog
  • Authentication
  • Developer Status Page
  • Data Types
  • Error Codes
  • White-labeling
​
Portal
Released Property Insurance and Price comparison
  • Issue Policies
  • Cancel Policies
  • Prices
  • Claims
​
Portal
Released WebhooksWebhooks
  • Webhook on Policy Status Update
  • Webhook on Policy Documents Update
​
APIsPortal
Released Horses Insurance
  • Get Livestock (Horse) Insurance from a public form
  • Also added the ability to get them from APIs