Users

FL3XX API (1.0.0)

FL3XX API allows partners to access flight information, airport details, and a vast array of aviation services.

Download OpenAPI description
index.json
index.yaml
Overview
URL https://www.fl3xx.com
FL3XX Integration Support integrations@fl3xx.com
License MIT
Languages
Servers
Test Server
https://test.fl3xx.com/

Accounting

Operations related to accounting.

Operations

Accounts

Operations related accounts.

Operations

Airports

Access and manage airport information.

Operations

Aircraft

Operations related to aircraft.

Operations

Booking Itinerary (Legs)

Operations related to flight itinerary legs.

Operations

Crew

Operations related to crew details.

Operations

Empty Legs

Operations related to empty leg flights.

Operations

Flights

Operations related to flights.

Operations

Flight Animals

Operations related flight animals.

Operations

Flight Cargo

Operations related to flight cargo.

Operations

Flight Crew

Operations related to crew for individual flights.

Operations

Flight Fixed Base Operator (FBO)

Operations related to FBO.

Operations

Flight Fuels

Operations related to fuel for flights.

Operations

Flight Ground Services

Operations related to ground services.

Operations

Flight Luggage

Operations related to luggage for flights.

Operations

Flight Migration

Operations related to migrations.

Operations

Flight Notifications

Operations related to notifications for flights.

Operations

Flight Passengers

Operations related to passenger for flights.

Operations

Flight PAX Details

Operations related to PAX details.

Operations

Flight Planning Notes

Operations related to planning notes for flights.

Operations

Flight Post Flight

Operations related to post-flight activities.

Operations

Flight Pre Flight

Operations related to pre-flight operations.

Operations

Flight Sanction List

Operations related to flight sanctions and approvals.

Operations

Flight Travel Authorization

Operations related to travel authorization.

Operations

Flight Tickets

Operations related to flight tickets.

Operations

Quotes

Operations related to flight quotes.

Operations

Roster

Operations related to Rosters.

Operations

Users

Operations related to Users.

Operations

Get Users

Request

Fetches list of users.

Query
limitinteger(int32)

Maximum number of items returned

Default 100
offsetinteger(int32)

Offset

Default 0
curl -i -X GET \
  'https://test.fl3xx.com/api/external/user?limit=100&offset=0' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/jsonArray [
internalIdinteger(int64)read-only

Internal ID

Example: 485949
externalReferencestring

External reference

Example: "665321646"
firstNamestring

First Name

Example: "Luke"
lastNamestring

Last name

Example: "Joe"
genderstring

Gender

Enum"FEMALE""MALE""OTHER"
Example: "MALE"
birthDatestring(date)

Date of birth

Example: "1988-03-18"
birthPlacestring

Place of birth

Example: "Conroe"
acronymstring

Acronym

Example: "LJ"
birthCountrystring

Country of birth

Example: "US"
accountobject(AccountDto)
addressobject(AddressDto)
emailstring

Email address

Example: "myemail@fl3xx.com"
documentExpirationstring(date)

Expiration date

Example: "2030-04-03"
documentExternalReferenceinteger(int64)

Document reference

Example: 69905
documentNumberstring

Document number

Example: "CC4AA3390294NJ"
documentTypestring

Type of document

Enum"PASSPORT""IDCARD""VISA""OTHER""CREWID""AIRPORT_ID""DRIVING_LICENSE""US_GLOBAL""GREEN_CARD""PILOT_LICENSE"
Example: "PASSPORT"
issueCountrystring

Country of issue

Example: "USA"
issueDatestring(date)

Issuance date

Example: "2020-04-02"
linksobject(Links)
logNamestring
mobilestring

Mobile phone number

Example: 1111111111
nationalitystring

Nationality

Example: "US"
personnelNumberstring

Personnel number

Example: 996659598
phonestring

Phone number

Example: 11111111111
radiationProtectionRegistryIdstring

Radiation projection registry id

Example: 1112221112221
salutationstring
Enum"Mr""Mrs""Miss""Ms""unDef""Dr""Ing""Prof""Mag""Captain"
Example: "Mr"
siflTypestring
Enum"CONTROL""NON_CONTROL""SECURITY"
Example: "CONTROL"
statusstring

Record status

Enum"ACTIVE""DELETED""INACTIVE""MIGRATED_US"
Example: "ACTIVE"
weightnumber(float)

Weight

Example: 80.5
]
Response
application/json
[
  {
    "internalId": 485949,
    "externalReference": "665321646",
    "firstName": "Luke",
    "lastName": "Joe",
    "gender": "MALE",
    "birthDate": "1988-03-18",
    "birthPlace": "Conroe",
    "acronym": "LJ",
    "birthCountry": "US",
    "account": { … },
    "address": { … },
    "email": "myemail@fl3xx.com",
    "documentExpiration": "2030-04-03",
    "documentExternalReference": 69905,
    "documentNumber": "CC4AA3390294NJ",
    "documentType": "PASSPORT",
    "issueCountry": "USA",
    "issueDate": "2020-04-02",
    "links": { … },
    "logName": "string",
    "mobile": 1111111111,
    "nationality": "US",
    "personnelNumber": 996659598,
    "phone": 11111111111,
    "radiationProtectionRegistryId": 1112221112221,
    "salutation": "Mr",
    "siflType": "CONTROL",
    "status": "ACTIVE",
    "weight": 80.5
  }
]

Creates a new user

Request

Creates a user

Bodyapplication/json

user

externalReferencestring

External reference

Example: "665321646"
firstNamestring

First Name

Example: "Luke"
lastNamestring

Last name

Example: "Joe"
genderstring

Gender

Enum"FEMALE""MALE""OTHER"
Example: "MALE"
birthDatestring(date)

Date of birth

Example: "1988-03-18"
birthPlacestring

Place of birth

Example: "Conroe"
acronymstring

Acronym

Example: "LJ"
birthCountrystring

Country of birth

Example: "US"
accountobject(AccountDto)
addressobject(AddressDto)
emailstring

Email address

Example: "myemail@fl3xx.com"
documentExpirationstring(date)

Expiration date

Example: "2030-04-03"
documentExternalReferenceinteger(int64)

Document reference

Example: 69905
documentNumberstring

Document number

Example: "CC4AA3390294NJ"
documentTypestring

Type of document

Enum"PASSPORT""IDCARD""VISA""OTHER""CREWID""AIRPORT_ID""DRIVING_LICENSE""US_GLOBAL""GREEN_CARD""PILOT_LICENSE"
Example: "PASSPORT"
issueCountrystring

Country of issue

Example: "USA"
issueDatestring(date)

Issuance date

Example: "2020-04-02"
linksobject(Links)
logNamestring
mobilestring

Mobile phone number

Example: 1111111111
nationalitystring

Nationality

Example: "US"
personnelNumberstring

Personnel number

Example: 996659598
phonestring

Phone number

Example: 11111111111
radiationProtectionRegistryIdstring

Radiation projection registry id

Example: 1112221112221
salutationstring
Enum"Mr""Mrs""Miss""Ms""unDef""Dr""Ing""Prof""Mag""Captain"
Example: "Mr"
siflTypestring
Enum"CONTROL""NON_CONTROL""SECURITY"
Example: "CONTROL"
statusstring

Record status

Enum"ACTIVE""DELETED""INACTIVE""MIGRATED_US"
Example: "ACTIVE"
weightnumber(float)

Weight

Example: 80.5
curl -i -X POST \
  https://test.fl3xx.com/api/external/user \
  -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE' \
  -d '{
    "externalReference": "665321646",
    "firstName": "Luke",
    "lastName": "Joe",
    "gender": "MALE",
    "birthDate": "1988-03-18",
    "birthPlace": "Conroe",
    "acronym": "LJ",
    "birthCountry": "US",
    "account": {
      "accountNumber": 1111,
      "email": "email@fl3xx.com",
      "externalReference": "669665849-f120-4f65-6325-11111",
      "mobile": 111111111,
      "name": "Account",
      "notes": "Notes",
      "phone": 111111111,
      "vatNumber": "A11111111111",
      "address": {
        "buildingDetails": "14th",
        "city": "Lisbon",
        "country": "Portugal",
        "externalReference": "External ref",
        "latitude": 0.1,
        "links": {
          "empty": true
        },
        "longitude": 0.1,
        "recipient": "Recipient",
        "street": "My Street",
        "type": "WORK",
        "zip": 111111
      },
      "links": {
        "empty": true
      }
    },
    "address": {
      "buildingDetails": "14th",
      "city": "Lisbon",
      "country": "Portugal",
      "externalReference": "External ref",
      "latitude": 0.1,
      "links": {
        "empty": true
      },
      "longitude": 0.1,
      "recipient": "Recipient",
      "street": "My Street",
      "type": "WORK",
      "zip": 111111
    },
    "email": "myemail@fl3xx.com",
    "documentExpiration": "2030-04-03",
    "documentExternalReference": 69905,
    "documentNumber": "CC4AA3390294NJ",
    "documentType": "PASSPORT",
    "issueCountry": "USA",
    "issueDate": "2020-04-02",
    "links": {
      "empty": true
    },
    "logName": "string",
    "mobile": 1111111111,
    "nationality": "US",
    "personnelNumber": 996659598,
    "phone": 11111111111,
    "radiationProtectionRegistryId": 1112221112221,
    "salutation": "Mr",
    "siflType": "CONTROL",
    "status": "ACTIVE",
    "weight": 80.5
  }'

Responses

Success

Bodyapplication/json
internalIdinteger(int64)read-only

Internal ID

Example: 485949
externalReferencestring

External reference

Example: "665321646"
firstNamestring

First Name

Example: "Luke"
lastNamestring

Last name

Example: "Joe"
genderstring

Gender

Enum"FEMALE""MALE""OTHER"
Example: "MALE"
birthDatestring(date)

Date of birth

Example: "1988-03-18"
birthPlacestring

Place of birth

Example: "Conroe"
acronymstring

Acronym

Example: "LJ"
birthCountrystring

Country of birth

Example: "US"
accountobject(AccountDto)
addressobject(AddressDto)
emailstring

Email address

Example: "myemail@fl3xx.com"
documentExpirationstring(date)

Expiration date

Example: "2030-04-03"
documentExternalReferenceinteger(int64)

Document reference

Example: 69905
documentNumberstring

Document number

Example: "CC4AA3390294NJ"
documentTypestring

Type of document

Enum"PASSPORT""IDCARD""VISA""OTHER""CREWID""AIRPORT_ID""DRIVING_LICENSE""US_GLOBAL""GREEN_CARD""PILOT_LICENSE"
Example: "PASSPORT"
issueCountrystring

Country of issue

Example: "USA"
issueDatestring(date)

Issuance date

Example: "2020-04-02"
linksobject(Links)
logNamestring
mobilestring

Mobile phone number

Example: 1111111111
nationalitystring

Nationality

Example: "US"
personnelNumberstring

Personnel number

Example: 996659598
phonestring

Phone number

Example: 11111111111
radiationProtectionRegistryIdstring

Radiation projection registry id

Example: 1112221112221
salutationstring
Enum"Mr""Mrs""Miss""Ms""unDef""Dr""Ing""Prof""Mag""Captain"
Example: "Mr"
siflTypestring
Enum"CONTROL""NON_CONTROL""SECURITY"
Example: "CONTROL"
statusstring

Record status

Enum"ACTIVE""DELETED""INACTIVE""MIGRATED_US"
Example: "ACTIVE"
weightnumber(float)

Weight

Example: 80.5
Response
application/json
{
  "internalId": 485949,
  "externalReference": "665321646",
  "firstName": "Luke",
  "lastName": "Joe",
  "gender": "MALE",
  "birthDate": "1988-03-18",
  "birthPlace": "Conroe",
  "acronym": "LJ",
  "birthCountry": "US",
  "account": {
    "accountNumber": 1111,
    "accountid": 1111,
    "email": "email@fl3xx.com",
    "externalReference": "669665849-f120-4f65-6325-11111",
    "internalId": 632123,
    "mobile": 111111111,
    "name": "Account",
    "notes": "Notes",
    "phone": 111111111,
    "vatNumber": "A11111111111",
    "address": { … },
    "links": { … }
  },
  "address": {
    "buildingDetails": "14th",
    "city": "Lisbon",
    "country": "Portugal",
    "externalReference": "External ref",
    "internalId": 334455,
    "latitude": 0.1,
    "links": { … },
    "longitude": 0.1,
    "recipient": "Recipient",
    "street": "My Street",
    "type": "WORK",
    "zip": 111111
  },
  "email": "myemail@fl3xx.com",
  "documentExpiration": "2030-04-03",
  "documentExternalReference": 69905,
  "documentNumber": "CC4AA3390294NJ",
  "documentType": "PASSPORT",
  "issueCountry": "USA",
  "issueDate": "2020-04-02",
  "links": {
    "empty": true
  },
  "logName": "string",
  "mobile": 1111111111,
  "nationality": "US",
  "personnelNumber": 996659598,
  "phone": 11111111111,
  "radiationProtectionRegistryId": 1112221112221,
  "salutation": "Mr",
  "siflType": "CONTROL",
  "status": "ACTIVE",
  "weight": 80.5
}

Get Flight Passengers

Request

Fetches data for flight passenger using its externalReference

Path
externalReferencestringrequired

externalReference

curl -i -X GET \
  'https://test.fl3xx.com/api/external/user/flight/{externalReference}' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/jsonArray [
internalIdinteger(int64)read-only

Internal ID

Example: 485949
externalReferencestring

External reference

Example: "665321646"
firstNamestring

First Name

Example: "Luke"
lastNamestring

Last name

Example: "Joe"
genderstring

Gender

Enum"FEMALE""MALE""OTHER"
Example: "MALE"
birthDatestring(date)

Date of birth

Example: "1988-03-18"
birthPlacestring

Place of birth

Example: "Conroe"
acronymstring

Acronym

Example: "LJ"
birthCountrystring

Country of birth

Example: "US"
accountobject(AccountDto)
addressobject(AddressDto)
emailstring

Email address

Example: "myemail@fl3xx.com"
documentExpirationstring(date)

Expiration date

Example: "2030-04-03"
documentExternalReferenceinteger(int64)

Document reference

Example: 69905
documentNumberstring

Document number

Example: "CC4AA3390294NJ"
documentTypestring

Type of document

Enum"PASSPORT""IDCARD""VISA""OTHER""CREWID""AIRPORT_ID""DRIVING_LICENSE""US_GLOBAL""GREEN_CARD""PILOT_LICENSE"
Example: "PASSPORT"
issueCountrystring

Country of issue

Example: "USA"
issueDatestring(date)

Issuance date

Example: "2020-04-02"
linksobject(Links)
logNamestring
mobilestring

Mobile phone number

Example: 1111111111
nationalitystring

Nationality

Example: "US"
personnelNumberstring

Personnel number

Example: 996659598
phonestring

Phone number

Example: 11111111111
radiationProtectionRegistryIdstring

Radiation projection registry id

Example: 1112221112221
salutationstring
Enum"Mr""Mrs""Miss""Ms""unDef""Dr""Ing""Prof""Mag""Captain"
Example: "Mr"
siflTypestring
Enum"CONTROL""NON_CONTROL""SECURITY"
Example: "CONTROL"
statusstring

Record status

Enum"ACTIVE""DELETED""INACTIVE""MIGRATED_US"
Example: "ACTIVE"
weightnumber(float)

Weight

Example: 80.5
]
Response
application/json
[
  {
    "internalId": 485949,
    "externalReference": "665321646",
    "firstName": "Luke",
    "lastName": "Joe",
    "gender": "MALE",
    "birthDate": "1988-03-18",
    "birthPlace": "Conroe",
    "acronym": "LJ",
    "birthCountry": "US",
    "account": { … },
    "address": { … },
    "email": "myemail@fl3xx.com",
    "documentExpiration": "2030-04-03",
    "documentExternalReference": 69905,
    "documentNumber": "CC4AA3390294NJ",
    "documentType": "PASSPORT",
    "issueCountry": "USA",
    "issueDate": "2020-04-02",
    "links": { … },
    "logName": "string",
    "mobile": 1111111111,
    "nationality": "US",
    "personnelNumber": 996659598,
    "phone": 11111111111,
    "radiationProtectionRegistryId": 1112221112221,
    "salutation": "Mr",
    "siflType": "CONTROL",
    "status": "ACTIVE",
    "weight": 80.5
  }
]

Get a User

Request

Fetch data about a User

Path
externalReferencestringrequired

externalReference

curl -i -X GET \
  'https://test.fl3xx.com/api/external/user/{externalReference}' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
internalIdinteger(int64)read-only

Internal ID

Example: 485949
externalReferencestring

External reference

Example: "665321646"
firstNamestring

First Name

Example: "Luke"
lastNamestring

Last name

Example: "Joe"
genderstring

Gender

Enum"FEMALE""MALE""OTHER"
Example: "MALE"
birthDatestring(date)

Date of birth

Example: "1988-03-18"
birthPlacestring

Place of birth

Example: "Conroe"
acronymstring

Acronym

Example: "LJ"
birthCountrystring

Country of birth

Example: "US"
accountobject(AccountDto)
addressobject(AddressDto)
emailstring

Email address

Example: "myemail@fl3xx.com"
documentExpirationstring(date)

Expiration date

Example: "2030-04-03"
documentExternalReferenceinteger(int64)

Document reference

Example: 69905
documentNumberstring

Document number

Example: "CC4AA3390294NJ"
documentTypestring

Type of document

Enum"PASSPORT""IDCARD""VISA""OTHER""CREWID""AIRPORT_ID""DRIVING_LICENSE""US_GLOBAL""GREEN_CARD""PILOT_LICENSE"
Example: "PASSPORT"
issueCountrystring

Country of issue

Example: "USA"
issueDatestring(date)

Issuance date

Example: "2020-04-02"
linksobject(Links)
logNamestring
mobilestring

Mobile phone number

Example: 1111111111
nationalitystring

Nationality

Example: "US"
personnelNumberstring

Personnel number

Example: 996659598
phonestring

Phone number

Example: 11111111111
radiationProtectionRegistryIdstring

Radiation projection registry id

Example: 1112221112221
salutationstring
Enum"Mr""Mrs""Miss""Ms""unDef""Dr""Ing""Prof""Mag""Captain"
Example: "Mr"
siflTypestring
Enum"CONTROL""NON_CONTROL""SECURITY"
Example: "CONTROL"
statusstring

Record status

Enum"ACTIVE""DELETED""INACTIVE""MIGRATED_US"
Example: "ACTIVE"
weightnumber(float)

Weight

Example: 80.5
Response
application/json
{
  "internalId": 485949,
  "externalReference": "665321646",
  "firstName": "Luke",
  "lastName": "Joe",
  "gender": "MALE",
  "birthDate": "1988-03-18",
  "birthPlace": "Conroe",
  "acronym": "LJ",
  "birthCountry": "US",
  "account": {
    "accountNumber": 1111,
    "accountid": 1111,
    "email": "email@fl3xx.com",
    "externalReference": "669665849-f120-4f65-6325-11111",
    "internalId": 632123,
    "mobile": 111111111,
    "name": "Account",
    "notes": "Notes",
    "phone": 111111111,
    "vatNumber": "A11111111111",
    "address": { … },
    "links": { … }
  },
  "address": {
    "buildingDetails": "14th",
    "city": "Lisbon",
    "country": "Portugal",
    "externalReference": "External ref",
    "internalId": 334455,
    "latitude": 0.1,
    "links": { … },
    "longitude": 0.1,
    "recipient": "Recipient",
    "street": "My Street",
    "type": "WORK",
    "zip": 111111
  },
  "email": "myemail@fl3xx.com",
  "documentExpiration": "2030-04-03",
  "documentExternalReference": 69905,
  "documentNumber": "CC4AA3390294NJ",
  "documentType": "PASSPORT",
  "issueCountry": "USA",
  "issueDate": "2020-04-02",
  "links": {
    "empty": true
  },
  "logName": "string",
  "mobile": 1111111111,
  "nationality": "US",
  "personnelNumber": 996659598,
  "phone": 11111111111,
  "radiationProtectionRegistryId": 1112221112221,
  "salutation": "Mr",
  "siflType": "CONTROL",
  "status": "ACTIVE",
  "weight": 80.5
}

Updates a User

Request

Updates a user

Path
externalReferencestringrequired

externalReference

Bodyapplication/jsonrequired

user

externalReferencestring

External reference

Example: "665321646"
firstNamestring

First Name

Example: "Luke"
lastNamestring

Last name

Example: "Joe"
genderstring

Gender

Enum"FEMALE""MALE""OTHER"
Example: "MALE"
birthDatestring(date)

Date of birth

Example: "1988-03-18"
birthPlacestring

Place of birth

Example: "Conroe"
acronymstring

Acronym

Example: "LJ"
birthCountrystring

Country of birth

Example: "US"
accountobject(AccountDto)
addressobject(AddressDto)
emailstring

Email address

Example: "myemail@fl3xx.com"
documentExpirationstring(date)

Expiration date

Example: "2030-04-03"
documentExternalReferenceinteger(int64)

Document reference

Example: 69905
documentNumberstring

Document number

Example: "CC4AA3390294NJ"
documentTypestring

Type of document

Enum"PASSPORT""IDCARD""VISA""OTHER""CREWID""AIRPORT_ID""DRIVING_LICENSE""US_GLOBAL""GREEN_CARD""PILOT_LICENSE"
Example: "PASSPORT"
issueCountrystring

Country of issue

Example: "USA"
issueDatestring(date)

Issuance date

Example: "2020-04-02"
linksobject(Links)
logNamestring
mobilestring

Mobile phone number

Example: 1111111111
nationalitystring

Nationality

Example: "US"
personnelNumberstring

Personnel number

Example: 996659598
phonestring

Phone number

Example: 11111111111
radiationProtectionRegistryIdstring

Radiation projection registry id

Example: 1112221112221
salutationstring
Enum"Mr""Mrs""Miss""Ms""unDef""Dr""Ing""Prof""Mag""Captain"
Example: "Mr"
siflTypestring
Enum"CONTROL""NON_CONTROL""SECURITY"
Example: "CONTROL"
statusstring

Record status

Enum"ACTIVE""DELETED""INACTIVE""MIGRATED_US"
Example: "ACTIVE"
weightnumber(float)

Weight

Example: 80.5
curl -i -X PUT \
  'https://test.fl3xx.com/api/external/user/{externalReference}' \
  -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE' \
  -d '{
    "externalReference": "665321646",
    "firstName": "Luke",
    "lastName": "Joe",
    "gender": "MALE",
    "birthDate": "1988-03-18",
    "birthPlace": "Conroe",
    "acronym": "LJ",
    "birthCountry": "US",
    "account": {
      "accountNumber": 1111,
      "email": "email@fl3xx.com",
      "externalReference": "669665849-f120-4f65-6325-11111",
      "mobile": 111111111,
      "name": "Account",
      "notes": "Notes",
      "phone": 111111111,
      "vatNumber": "A11111111111",
      "address": {
        "buildingDetails": "14th",
        "city": "Lisbon",
        "country": "Portugal",
        "externalReference": "External ref",
        "latitude": 0.1,
        "links": {
          "empty": true
        },
        "longitude": 0.1,
        "recipient": "Recipient",
        "street": "My Street",
        "type": "WORK",
        "zip": 111111
      },
      "links": {
        "empty": true
      }
    },
    "address": {
      "buildingDetails": "14th",
      "city": "Lisbon",
      "country": "Portugal",
      "externalReference": "External ref",
      "latitude": 0.1,
      "links": {
        "empty": true
      },
      "longitude": 0.1,
      "recipient": "Recipient",
      "street": "My Street",
      "type": "WORK",
      "zip": 111111
    },
    "email": "myemail@fl3xx.com",
    "documentExpiration": "2030-04-03",
    "documentExternalReference": 69905,
    "documentNumber": "CC4AA3390294NJ",
    "documentType": "PASSPORT",
    "issueCountry": "USA",
    "issueDate": "2020-04-02",
    "links": {
      "empty": true
    },
    "logName": "string",
    "mobile": 1111111111,
    "nationality": "US",
    "personnelNumber": 996659598,
    "phone": 11111111111,
    "radiationProtectionRegistryId": 1112221112221,
    "salutation": "Mr",
    "siflType": "CONTROL",
    "status": "ACTIVE",
    "weight": 80.5
  }'

Responses

Success

Bodyapplication/json
internalIdinteger(int64)read-only

Internal ID

Example: 485949
externalReferencestring

External reference

Example: "665321646"
firstNamestring

First Name

Example: "Luke"
lastNamestring

Last name

Example: "Joe"
genderstring

Gender

Enum"FEMALE""MALE""OTHER"
Example: "MALE"
birthDatestring(date)

Date of birth

Example: "1988-03-18"
birthPlacestring

Place of birth

Example: "Conroe"
acronymstring

Acronym

Example: "LJ"
birthCountrystring

Country of birth

Example: "US"
accountobject(AccountDto)
addressobject(AddressDto)
emailstring

Email address

Example: "myemail@fl3xx.com"
documentExpirationstring(date)

Expiration date

Example: "2030-04-03"
documentExternalReferenceinteger(int64)

Document reference

Example: 69905
documentNumberstring

Document number

Example: "CC4AA3390294NJ"
documentTypestring

Type of document

Enum"PASSPORT""IDCARD""VISA""OTHER""CREWID""AIRPORT_ID""DRIVING_LICENSE""US_GLOBAL""GREEN_CARD""PILOT_LICENSE"
Example: "PASSPORT"
issueCountrystring

Country of issue

Example: "USA"
issueDatestring(date)

Issuance date

Example: "2020-04-02"
linksobject(Links)
logNamestring
mobilestring

Mobile phone number

Example: 1111111111
nationalitystring

Nationality

Example: "US"
personnelNumberstring

Personnel number

Example: 996659598
phonestring

Phone number

Example: 11111111111
radiationProtectionRegistryIdstring

Radiation projection registry id

Example: 1112221112221
salutationstring
Enum"Mr""Mrs""Miss""Ms""unDef""Dr""Ing""Prof""Mag""Captain"
Example: "Mr"
siflTypestring
Enum"CONTROL""NON_CONTROL""SECURITY"
Example: "CONTROL"
statusstring

Record status

Enum"ACTIVE""DELETED""INACTIVE""MIGRATED_US"
Example: "ACTIVE"
weightnumber(float)

Weight

Example: 80.5
Response
application/json
{
  "internalId": 485949,
  "externalReference": "665321646",
  "firstName": "Luke",
  "lastName": "Joe",
  "gender": "MALE",
  "birthDate": "1988-03-18",
  "birthPlace": "Conroe",
  "acronym": "LJ",
  "birthCountry": "US",
  "account": {
    "accountNumber": 1111,
    "accountid": 1111,
    "email": "email@fl3xx.com",
    "externalReference": "669665849-f120-4f65-6325-11111",
    "internalId": 632123,
    "mobile": 111111111,
    "name": "Account",
    "notes": "Notes",
    "phone": 111111111,
    "vatNumber": "A11111111111",
    "address": { … },
    "links": { … }
  },
  "address": {
    "buildingDetails": "14th",
    "city": "Lisbon",
    "country": "Portugal",
    "externalReference": "External ref",
    "internalId": 334455,
    "latitude": 0.1,
    "links": { … },
    "longitude": 0.1,
    "recipient": "Recipient",
    "street": "My Street",
    "type": "WORK",
    "zip": 111111
  },
  "email": "myemail@fl3xx.com",
  "documentExpiration": "2030-04-03",
  "documentExternalReference": 69905,
  "documentNumber": "CC4AA3390294NJ",
  "documentType": "PASSPORT",
  "issueCountry": "USA",
  "issueDate": "2020-04-02",
  "links": {
    "empty": true
  },
  "logName": "string",
  "mobile": 1111111111,
  "nationality": "US",
  "personnelNumber": 996659598,
  "phone": 11111111111,
  "radiationProtectionRegistryId": 1112221112221,
  "salutation": "Mr",
  "siflType": "CONTROL",
  "status": "ACTIVE",
  "weight": 80.5
}

Deletes a User

Request

Deletes the user identified using its external reference

Path
externalReferencestringrequired

externalReference

curl -i -X DELETE \
  'https://test.fl3xx.com/api/external/user/{externalReference}' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

Success

Body

Get User Documents

Request

Get information about the documents of a user identified by the userExternalReference

Path
userExternalReferencestringrequired

userExternalReference

curl -i -X GET \
  'https://test.fl3xx.com/api/external/user/{userExternalReference}/documents' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/jsonArray [
documentobject(BinaryReferenceSharedDto)
expirationDatestring(date)
externalReferencestring
internalIdinteger(int64)
issueAuthoritystring
issueCountrystring
issueDatestring(date)
issuePlacestring
linksobject(Links)
mainboolean
numberstring
passportExternalReferencestring
typestring
Enum"PASSPORT""IDCARD""VISA""OTHER""CREWID""AIRPORT_ID""DRIVING_LICENSE""US_GLOBAL""GREEN_CARD""PILOT_LICENSE"
visaTypestring
]
Response
application/json
[
  {
    "document": { … },
    "expirationDate": "2019-08-24",
    "externalReference": "string",
    "internalId": 0,
    "issueAuthority": "string",
    "issueCountry": "string",
    "issueDate": "2019-08-24",
    "issuePlace": "string",
    "links": { … },
    "main": true,
    "number": "string",
    "passportExternalReference": "string",
    "type": "PASSPORT",
    "visaType": "string"
  }
]

Create a User Document

Request

Creates a new user document

Path
userExternalReferencestringrequired

userExternalReference

Bodyapplication/jsonrequired

document

documentobject(BinaryReferenceSharedDto)
expirationDatestring(date)
externalReferencestring
internalIdinteger(int64)
issueAuthoritystring
issueCountrystring
issueDatestring(date)
issuePlacestring
linksArray of objects(Link)
mainboolean
numberstring
passportExternalReferencestring
typestring
Enum"PASSPORT""IDCARD""VISA""OTHER""CREWID""AIRPORT_ID""DRIVING_LICENSE""US_GLOBAL""GREEN_CARD""PILOT_LICENSE"
visaTypestring
curl -i -X POST \
  'https://test.fl3xx.com/api/external/user/{userExternalReference}/documents' \
  -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE' \
  -d '{
    "document": {
      "customName": "string",
      "fileSize": 0,
      "id": 0,
      "imageSizeX": 0,
      "imageSizeY": 0,
      "isThumbnail": true,
      "name": "string",
      "originalName": "string",
      "uuid": "string"
    },
    "expirationDate": "2019-08-24",
    "externalReference": "string",
    "internalId": 0,
    "issueAuthority": "string",
    "issueCountry": "string",
    "issueDate": "2019-08-24",
    "issuePlace": "string",
    "links": [
      {
        "deprecation": "string",
        "href": "string",
        "hreflang": "string",
        "media": "string",
        "name": "string",
        "profile": "string",
        "rel": {},
        "title": "string",
        "type": "string"
      }
    ],
    "main": true,
    "number": "string",
    "passportExternalReference": "string",
    "type": "PASSPORT",
    "visaType": "string"
  }'

Responses

Success

Bodyapplication/json
documentobject(BinaryReferenceSharedDto)
expirationDatestring(date)
externalReferencestring
internalIdinteger(int64)
issueAuthoritystring
issueCountrystring
issueDatestring(date)
issuePlacestring
linksobject(Links)
mainboolean
numberstring
passportExternalReferencestring
typestring
Enum"PASSPORT""IDCARD""VISA""OTHER""CREWID""AIRPORT_ID""DRIVING_LICENSE""US_GLOBAL""GREEN_CARD""PILOT_LICENSE"
visaTypestring
Response
application/json
{
  "document": {
    "customName": "string",
    "fileSize": 0,
    "id": 0,
    "imageSizeX": 0,
    "imageSizeY": 0,
    "isThumbnail": true,
    "name": "string",
    "originalName": "string",
    "uuid": "string"
  },
  "expirationDate": "2019-08-24",
  "externalReference": "string",
  "internalId": 0,
  "issueAuthority": "string",
  "issueCountry": "string",
  "issueDate": "2019-08-24",
  "issuePlace": "string",
  "links": {
    "empty": true
  },
  "main": true,
  "number": "string",
  "passportExternalReference": "string",
  "type": "PASSPORT",
  "visaType": "string"
}

Update a User's Document

Request

Updates a user's document using the userExternalReference and the document's externalReference

Path
externalReferencestringrequired

externalReference

userExternalReferencestringrequired

userExternalReference

Bodyapplication/jsonrequired

userDocument

documentobject(BinaryReferenceSharedDto)
expirationDatestring(date)
externalReferencestring
internalIdinteger(int64)
issueAuthoritystring
issueCountrystring
issueDatestring(date)
issuePlacestring
linksArray of objects(Link)
mainboolean
numberstring
passportExternalReferencestring
typestring
Enum"PASSPORT""IDCARD""VISA""OTHER""CREWID""AIRPORT_ID""DRIVING_LICENSE""US_GLOBAL""GREEN_CARD""PILOT_LICENSE"
visaTypestring
curl -i -X PUT \
  'https://test.fl3xx.com/api/external/user/{userExternalReference}/documents/{externalReference}' \
  -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE' \
  -d '{
    "document": {
      "customName": "string",
      "fileSize": 0,
      "id": 0,
      "imageSizeX": 0,
      "imageSizeY": 0,
      "isThumbnail": true,
      "name": "string",
      "originalName": "string",
      "uuid": "string"
    },
    "expirationDate": "2019-08-24",
    "externalReference": "string",
    "internalId": 0,
    "issueAuthority": "string",
    "issueCountry": "string",
    "issueDate": "2019-08-24",
    "issuePlace": "string",
    "links": [
      {
        "deprecation": "string",
        "href": "string",
        "hreflang": "string",
        "media": "string",
        "name": "string",
        "profile": "string",
        "rel": {},
        "title": "string",
        "type": "string"
      }
    ],
    "main": true,
    "number": "string",
    "passportExternalReference": "string",
    "type": "PASSPORT",
    "visaType": "string"
  }'

Responses

Success

Bodyapplication/json
documentobject(BinaryReferenceSharedDto)
expirationDatestring(date)
externalReferencestring
internalIdinteger(int64)
issueAuthoritystring
issueCountrystring
issueDatestring(date)
issuePlacestring
linksobject(Links)
mainboolean
numberstring
passportExternalReferencestring
typestring
Enum"PASSPORT""IDCARD""VISA""OTHER""CREWID""AIRPORT_ID""DRIVING_LICENSE""US_GLOBAL""GREEN_CARD""PILOT_LICENSE"
visaTypestring
Response
application/json
{
  "document": {
    "customName": "string",
    "fileSize": 0,
    "id": 0,
    "imageSizeX": 0,
    "imageSizeY": 0,
    "isThumbnail": true,
    "name": "string",
    "originalName": "string",
    "uuid": "string"
  },
  "expirationDate": "2019-08-24",
  "externalReference": "string",
  "internalId": 0,
  "issueAuthority": "string",
  "issueCountry": "string",
  "issueDate": "2019-08-24",
  "issuePlace": "string",
  "links": {
    "empty": true
  },
  "main": true,
  "number": "string",
  "passportExternalReference": "string",
  "type": "PASSPORT",
  "visaType": "string"
}

Delete a User's Document

Request

Deletes an existing document based on the user's externalReference and the document's externalReference

Path
externalReferencestringrequired

externalReference

userExternalReferencestringrequired

userExternalReference

curl -i -X DELETE \
  'https://test.fl3xx.com/api/external/user/{userExternalReference}/documents/{externalReference}' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

Success

Body