Changelog
Start typing to search…
Back to All

💰New Endpoint: GET /earnings

11 days ago by Assad Aboultaif

💰 New Entity: earnings

  • A new entity, earnings, is now available across all verification endpoints.

  • This entity provides access to platform economy income data from ride-sharing and delivery services, including:

    • Monthly earnings history from Uber, Didi, and other gig platforms
    • Period-by-period income tracking (YYYY-MM format)
    • Platform source identification for each earnings record
    • Currency information for all transactions

  • This data captures gig economy income that traditional employment records (IMSS/ISSSTE) and invoices don't fully represent, enabling you to assess creditworthiness for individuals working in the platform economy. For more information, check our documentation here.

🆕 New Endpoint: GET /earnings/

  • A new endpoint, GET /earnings, is now available.

  • Returns earnings history with monthly income data from connected platforms.

  • Supports pagination for large earnings histories.

  • Each earnings record includes period, amount, currency, and platform identification.

🔄 Updated Responses

The following endpoints now include earnings in their response schemas:

  • GET /verifications/verification_id: The entities array now includes "earnings" when platform economy earnings data is available.

  • GET /verifications (List): Each verification object in the response now includes earnings in the entities array when applicable.

  • Webhook Events: Both verification.completed and verification.historical webhook payloads now include "earnings" in the entities array when earnings data is available.

💡 What This Means for You

  • No breaking changes — existing integrations continue to work without modifications.

  • If your application needs to evaluate income from platform economy work (Uber, Didi, etc.), you can now access this data programmatically.

  • This data complements traditional employment and invoice records, providing a more complete picture of an individual's income sources.

  • Check the entities array in webhook notifications or verification responses to determine if earnings data is available before making the API call.