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

  • 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

Responses

POST /signup
curl \
 -X POST https://api-dev.gatego.io:443/signup \
 -H "Content-Type: application/json" \
 -d '{"account":{"can_view_other_carriers":true,"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":{"address":"string","email":"string","name":"string","organization_group_id":42,"phone_number":"string"},"payment_method":{"email":"string","provider_payment_method_id":"string"}}'
Request examples
# Headers

# Payload
{
  "account": {
    "can_view_other_carriers": true,
    "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": {
    "address": "string",
    "email": "string",
    "name": "string",
    "organization_group_id": 42,
    "phone_number": "string"
  },
  "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": "2024-05-04T09:42:00+00:00",
    "driver": {
      "license": "string",
      "license_expiration": "2024-05-04T09:42:00+00:00",
      "license_picture_id": "string",
      "photo_id": "string",
      "safety_card_picture_id": "string",
      "truck_number": "string"
    },
    "driver_license": "string",
    "driver_license_expiration": "2024-05-04T09:42:00+00:00",
    "driver_license_picture_id": 42,
    "driver_photo_id": 42,
    "driver_safety_card_picture_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": "2024-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": "2024-05-04T09:42:00+00:00",
    "role": "ADMIN",
    "username": "string",
    "yard_id": 42
  },
  "initial_subscriptions": [
    {
      "active": true,
      "aggregate_usage": "string",
      "amount": 42,
      "created": "2024-05-04T09:42:00+00:00",
      "currency": "string",
      "current_period_end": "2024-05-04T09:42:00+00:00",
      "current_period_start": "2024-05-04T09:42:00+00:00",
      "days_until_due": 42,
      "id": "string",
      "price_id": "string",
      "status": "string",
      "tiers_mode": "string",
      "trial_end": "2024-05-04T09:42:00+00:00",
      "trial_period_days": 42,
      "trial_start": "2024-05-04T09:42:00+00:00"
    }
  ],
  "organization": {
    "address": "string",
    "created_at": "2024-05-04T09:42:00+00:00",
    "email": "string",
    "id": 42,
    "name": "string",
    "organization_group_id": 42,
    "phone_number": "string"
  },
  "payment_method": {
    "card": {
      "brand": "string",
      "country": "string",
      "created": 42,
      "exp_month": 42,
      "exp_year": 42,
      "last4": "string"
    },
    "email": "string",
    "id": "string"
  }
}