gatego API documentation

Checks if an account exists

POST /signup

Checks if an account exists with the given email or username (not necessarily the same account has to have that email and username at the same time)

Headers

X-Gatego-oid

Specify effective organization_id for Admin and Group Organization Admins. This is a global header for all endpoints only taken into consideration when it makes sense (it won't be used in Auth, for example)

application/json

Body

account object Required
Hide account attributes Show account attributes
- can_view_carrier_ids array[integer(int64)]
- can_view_other_carriers boolean
- carrier_id integer(int64)
- driver_license string
- driver_license_expiration string(date-time)
- driver_license_picture_id integer(int64)
- driver_photo_id integer(int64)
- driver_truck_carrier_id integer(int64)
- driver_truck_id integer(int64)
- driver_truck_number string
- email string
- language_code string
- name string Required
- password string
- password_confirmation string
- phone_number string
- username string
  
  username can be currently empty, for use cases when it is better and mandatory using an email/phone, in this case a unique username will be auto-generated
- yard_id integer(int64)
initial_subscriptions array[object]
Hide initial_subscriptions attribute Show initial_subscriptions attribute
- payment_provider_price_id string Required
organization object Required
Hide organization attributes Show organization attributes
- name string Required
- organization_group_id integer(int64)
  
  Only for GLOBAL ADMINs. Organization Group Id of the Organization Group which controls this organization (if any). When used by GROUP ADMINs, this field is automatically set to their managed organizationGroup
payment_method object
Hide payment_method attributes Show payment_method attributes
- email string
- provider_payment_method_id string

Responses

• 200

OK
Hide response attributes Show response attributes object
- account object
  
  Hide account attributes Show account attributes
  
  active boolean
  
  can_view_carrier_ids array[integer(int64)]
  
  can_view_other_carriers boolean
  
  carrier_id integer(int64)
  
  deleted_at string(date-time)
  
  driver object
  
  Hide driver attributes Show driver attributes
  
  license string
  
  license_expiration string(date-time)
  
  license_picture_id string
  
  photo_id string
  
  truck_number string
  
  driver_license string
  
  driver_license_expiration string(date-time)
  
  driver_license_picture_id integer(int64)
  
  driver_photo_id integer(int64)
  
  driver_truck_number string
  
  email string
  
  email_confirmed boolean
  
  Whether user has confirmed his email address
  
  hmac string
  
  HMAC-SHA256 of the user id
  
  hmac_android string
  
  hmac_ios string
  
  id integer(int64)
  
  language_code string
  
  last_login string(date-time)
  
  last_login_app_version string
  
  last_login_referer string
  
  managed_organization_group object
  
  Hide managed_organization_group attributes Show managed_organization_group attributes
  
  id integer(int64)
  
  managed_organizations array[object]
  
  Hide managed_organizations attributes Show managed_organizations attributes
  
  id integer(int64)
  
  name string
  
  name string
  
  name string
  
  organization object
  
  Hide organization attributes Show organization attributes
  
  id integer(int64)
  
  name string
  
  phone_number string
  
  previous_last_login string(date-time)
  
  role string
  
  Values are ADMIN, CARRIER_ADMIN, DRIVER, GUARD, ORG_ADMIN, ORG_GROUP_ADMIN, SIGNUP_SERVICE, or SUPER_CARRIER_ADMIN.
  
  username string
  
  yard_id integer(int64)
- initial_subscriptions array[object]
  
  Hide initial_subscriptions attributes Show initial_subscriptions attributes
  
  active boolean
  
  aggregate_usage string
  
  amount integer(int64)
  
  created string(date-time)
  
  currency string
  
  current_period_end string(date-time)
  
  current_period_start string(date-time)
  
  days_until_due integer(int32)
  
  id string
  
  price_id string
  
  status string
  
  tiers_mode string
  
  trial_end string(date-time)
  
  trial_period_days integer(int64)
  
  trial_start string(date-time)
- organization object
  
  Hide organization attributes Show organization attributes
  
  id integer(int64)
  
  name string
  
  organization_group_id integer(int64)
- payment_method object
  
  Hide payment_method attributes Show payment_method attributes
  
  card object
  
  Hide card attributes Show card attributes
  
  brand string
  
  country string
  
  created integer(int64)
  
  exp_month integer(int32)
  
  exp_year integer(int32)
  
  last4 string
  
  email string
  
  id string
• 201

Created
• 401

Unauthorized
• 403

Forbidden
• 404

Not Found

POST /signup

curl \
 -X POST https://api-dev.gatego.io:443/signup \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"account":{"can_view_carrier_ids":[42],"can_view_other_carriers":true,"carrier_id":42,"driver_license":"string","driver_license_expiration":"2023-05-04T09:42:00+00:00","driver_license_picture_id":42,"driver_photo_id":42,"driver_truck_carrier_id":42,"driver_truck_id":42,"driver_truck_number":"string","email":"string","language_code":"string","name":"string","password":"string","password_confirmation":"string","phone_number":"string","username":"string","yard_id":42},"initial_subscriptions":[{"payment_provider_price_id":"string"}],"organization":{"name":"string","organization_group_id":42},"payment_method":{"email":"string","provider_payment_method_id":"string"}}'

Request example

# Headers

# Payload
{
  "account": {
    "can_view_carrier_ids": [
      42
    ],
    "can_view_other_carriers": true,
    "carrier_id": 42,
    "driver_license": "string",
    "driver_license_expiration": "2023-05-04T09:42:00+00:00",
    "driver_license_picture_id": 42,
    "driver_photo_id": 42,
    "driver_truck_carrier_id": 42,
    "driver_truck_id": 42,
    "driver_truck_number": "string",
    "email": "string",
    "language_code": "string",
    "name": "string",
    "password": "string",
    "password_confirmation": "string",
    "phone_number": "string",
    "username": "string",
    "yard_id": 42
  },
  "initial_subscriptions": [
    {
      "payment_provider_price_id": "string"
    }
  ],
  "organization": {
    "name": "string",
    "organization_group_id": 42
  },
  "payment_method": {
    "email": "string",
    "provider_payment_method_id": "string"
  }
}

Response examples (200)

{
  "account": {
    "active": true,
    "can_view_carrier_ids": [
      42
    ],
    "can_view_other_carriers": true,
    "carrier_id": 42,
    "deleted_at": "2023-05-04T09:42:00+00:00",
    "driver": {
      "license": "string",
      "license_expiration": "2023-05-04T09:42:00+00:00",
      "license_picture_id": "string",
      "photo_id": "string",
      "truck_number": "string"
    },
    "driver_license": "string",
    "driver_license_expiration": "2023-05-04T09:42:00+00:00",
    "driver_license_picture_id": 42,
    "driver_photo_id": 42,
    "driver_truck_number": "string",
    "email": "string",
    "email_confirmed": false,
    "hmac": "string",
    "hmac_android": "string",
    "hmac_ios": "string",
    "id": 42,
    "language_code": "string",
    "last_login": "2023-05-04T09:42:00+00:00",
    "last_login_app_version": "string",
    "last_login_referer": "string",
    "managed_organization_group": {
      "id": 42,
      "managed_organizations": [
        {
          "id": 42,
          "name": "string"
        }
      ],
      "name": "string"
    },
    "name": "string",
    "organization": {
      "id": 42,
      "name": "string"
    },
    "phone_number": "string",
    "previous_last_login": "2023-05-04T09:42:00+00:00",
    "role": "ADMIN",
    "username": "string",
    "yard_id": 42
  },
  "initial_subscriptions": [
    {
      "active": true,
      "aggregate_usage": "string",
      "amount": 42,
      "created": "2023-05-04T09:42:00+00:00",
      "currency": "string",
      "current_period_end": "2023-05-04T09:42:00+00:00",
      "current_period_start": "2023-05-04T09:42:00+00:00",
      "days_until_due": 42,
      "id": "string",
      "price_id": "string",
      "status": "string",
      "tiers_mode": "string",
      "trial_end": "2023-05-04T09:42:00+00:00",
      "trial_period_days": 42,
      "trial_start": "2023-05-04T09:42:00+00:00"
    }
  ],
  "organization": {
    "id": 42,
    "name": "string",
    "organization_group_id": 42
  },
  "payment_method": {
    "card": {
      "brand": "string",
      "country": "string",
      "created": 42,
      "exp_month": 42,
      "exp_year": 42,
      "last4": "string"
    },
    "email": "string",
    "id": "string"
  }
}