Account Definition
An Account
is the entity that represents the connection of a User
with a specific platform.
You can access a worker's account by calling the /accounts/:account_id endpoint.
These are the variables contained within Account
:
Variable | Description | Type | Example |
---|---|---|---|
account_id | Account ID | uuid | 628cdf56-95f1-4397-a154-281112781240 |
country | Country of Operation | string | mx |
platform | Platform Name | string | imss |
identifier | User's identifier in the platform (Usually phone or email) | string | gonzalo@palenca.com |
worker_id | Worker ID used by the platform | string | 628cdf56-95f1-4397-a154-281112781240 |
warning | Warning for account | string | banned |
status | Account Status | string | success |
status_details | Reason for Account Status | string | curp_has_inconsistencies |