Skip to main content

Entities and Logins

To retrieve a worker's employment or earnings information, you need to create an Account, which represents the connection between your User and a specific platform. Each connection (Login) follows a flow through which employment data is obtained.

User

Represents a formal or gig economy worker (Uber, Rappi, Didi, etc.)

Account

Represents a worker account on a specific platform. Example: The worker's Uber account. We will reference this entity whenever we want to obtain information through the API. For example: Uber account profile data, Uber account earnings data. To consult the related routes, click here

Login

Represents an attempt to obtain employment or earnings information from the worker's account. Example: The attempt to obtain the worker's earnings information at Uber on August 15, 2023 at 08:00 hrs.

img.png

info

The route that is responsible for creating the User and the Account is /users/accounts (request POST)