CAcargoai

Create User

Changed on

This document outlines the process for self-user provisioning using the CargoCONNECT API. This endpoint facilitates the addition of users to your existing authorized API key. Field formats are listed on the Data Format page.

post/users

Request

  • Base URL
    https://api.cargoai.co/solutions
  • URL
    https://api.cargoai.co/solutions/users
  • Auth
    API key in header x-api-key

Headers

x-api-keystring required

Request body

firstNamestring required

first name of the user

lastNamestring required

last name of the user

emailstring required

user's email address

companyNamestring required

user's company name

iataCodestring

user's IATA code

cassCodestring

user's Cass code

countryCodestring

user's country code. Required when offices is not provided.

officeAirportCodestring

user's office airport code (or closest airport)

partnerIdstring

user's custom identifier in partner system

Response

200

status'Activated' | 'Manual activation' | 'Pending validation' | 'Pending company validation'

account status of the user. Omitted when the status is not one of the listed values.

messagestring

result of the request

tokenstring

authentication token for the CargoMART portal

linkstring

redirection link to the CargoMART portal, including the token

Changes