API reference
/
User management
/
Users
/
Update user business info

User Management API (v2)

Download OpenAPI description
UsersApi.json
UsersApi.yaml
Languages
Servers
Staging URL
https://apis.spotnana.com/
Spotnana mock server
https://developer.spotnana.com/_mock/openapi/usersapi/

Users

APIs to onboard and manage users.

Operations

Get user business info

Request

This endpoint gets user business info by user ID.

Path
userIdstring(uuid)required

Identifier for user.

Example: 4974a66b-7493-4f41-908c-58ba81093947
Query
includeInactiveboolean

Include inactive users.

Default false
Example: includeInactive=true
curl -i -X GET \
  'https://apis.spotnana.com/v2/users/4974a66b-7493-4f41-908c-58ba81093947/business-info?includeInactive=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
departmentRefobject(Reference)

Reference of an entity

designationstring
Example: "MANAGER"
emailstring(email)
Example: "user@business.com"
employeeIdstring

Unique employee id. Can use email if a company don't use employee ids.

Example: "101"
gradeRefobject(Reference)

Reference of an entity

legalEntityRefobject(Reference)required

Reference of an entity

legalEntityRef.​idstring(uuid)required
legalEntityRef.​namestring
managerRefobject(Reference)

Reference of an entity

officeRefobject(Reference)

Reference of an entity

organizationRefobject(Reference)required

Reference of an entity

organizationRef.​idstring(uuid)required
organizationRef.​namestring
phoneNumbersArray of objects(PhoneNumber)
costCenterRefobject(Reference)

Reference of an entity

countryCodestring

alpha-2 or alpha-3 ISO country code.

Example: "USA"
workerTypestring(WorkerType)

The type of worker.

Enum"EMPLOYEE""CONTINGENT""SEASONAL""INTERN"
accountingCodestring

Code used for accounting.

Example: "123"
companySpecifiedAttributesArray of objects(CompanySpecifiedAttribute)
designatedApproverRefsArray of objects(Reference object containing uuid and name of the entity.)

A list of references for designated approvers.

authorizerEmailstringDeprecated

Email address to be used as approval authorizer, when a manager is not present.

Example: "example@email.com"
Response
application/json
{
  "departmentRef": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "designation": "MANAGER",
  "email": "user@business.com",
  "employeeId": "101",
  "gradeRef": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "legalEntityRef": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "managerRef": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "officeRef": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "organizationRef": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "phoneNumbers": [
    { … }
  ],
  "costCenterRef": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "countryCode": "USA",
  "workerType": "EMPLOYEE",
  "accountingCode": "123",
  "companySpecifiedAttributes": [
    { … }
  ],
  "designatedApproverRefs": [
    { … }
  ],
  "authorizerEmail": "example@email.com"
}

Update user business info

Request

This endpoint updates user business info by user ID.

Path
userIdstring(uuid)required

Identifier for user.

Example: 4974a66b-7493-4f41-908c-58ba81093947
Query
includeInactiveboolean

Include inactive users.

Default false
Example: includeInactive=true
Bodyapplication/jsonrequired
departmentRefobject(Reference)

Reference of an entity

designationstring
Example: "MANAGER"
emailstring(email)
Example: "user@business.com"
employeeIdstring

Unique employee id. Can use email if a company don't use employee ids.

Example: "101"
gradeRefobject(Reference)

Reference of an entity

legalEntityRefobject(Reference)required

Reference of an entity

legalEntityRef.​idstring(uuid)required
legalEntityRef.​namestring
managerRefobject(Reference)

Reference of an entity

officeRefobject(Reference)

Reference of an entity

organizationRefobject(Reference)required

Reference of an entity

organizationRef.​idstring(uuid)required
organizationRef.​namestring
phoneNumbersArray of objects(PhoneNumber)
costCenterRefobject(Reference)

Reference of an entity

countryCodestring

alpha-2 or alpha-3 ISO country code.

Example: "USA"
workerTypestring(WorkerType)

The type of worker.

Enum"EMPLOYEE""CONTINGENT""SEASONAL""INTERN"
accountingCodestring

Code used for accounting.

Example: "123"
companySpecifiedAttributesArray of objects(CompanySpecifiedAttribute)
designatedApproverRefsArray of objects(Reference object containing uuid and name of the entity.)

A list of references for designated approvers.

authorizerEmailstringDeprecated

Email address to be used as approval authorizer, when a manager is not present.

Example: "example@email.com"
curl -i -X PUT \
  'https://apis.spotnana.com/v2/users/4974a66b-7493-4f41-908c-58ba81093947/business-info?includeInactive=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "departmentRef": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string"
    },
    "designation": "MANAGER",
    "email": "user@business.com",
    "employeeId": "101",
    "gradeRef": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string"
    },
    "legalEntityRef": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string"
    },
    "managerRef": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string"
    },
    "officeRef": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string"
    },
    "organizationRef": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string"
    },
    "phoneNumbers": [
      {
        "countryCode": 91,
        "countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
        "extension": "222",
        "isoCountryCode": "IN",
        "italianLeadingZero": true,
        "nationalNumber": 8150,
        "numberOfLeadingZeros": 1,
        "preferredDomesticCarrierCode": "7",
        "rawInput": "77777",
        "type": "MOBILE"
      }
    ],
    "costCenterRef": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string"
    },
    "countryCode": "USA",
    "workerType": "EMPLOYEE",
    "accountingCode": "123",
    "companySpecifiedAttributes": [
      {
        "fixedColumnName": "contingentType",
        "value": "FSTV"
      }
    ],
    "designatedApproverRefs": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      }
    ],
    "authorizerEmail": "example@email.com"
  }'

Responses

OK

Response
No content

Get user personal info

Request

This endpoint gets user personal info by user ID.

Path
userIdstring(uuid)required

Identifier for user.

Example: 4974a66b-7493-4f41-908c-58ba81093947
Query
includeInactiveboolean

Include inactive users.

Default false
Example: includeInactive=true
curl -i -X GET \
  'https://apis.spotnana.com/v2/users/4974a66b-7493-4f41-908c-58ba81093947/personal-info?includeInactive=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
addressesArray of objects(PostalAddress)
dobobject(DateModel)

Date in ISO 8601 standard.

emailstring(email)
Example: "example@email.com"
genderstring(Gender)
Enum"MALE""FEMALE""UNSPECIFIED""UNDISCLOSED"
identityDocsArray of PassportWrapper (object) or ImmigrationDocumentWrapper (object) or RedressNumberWrapper (object) or KnownTravelerNumberWrapper (object) or NationalDocWrapper (object)(IdentityDocument)

List of user identity documents.

Example: [{"passport":{"docId":"PASSPORTID","expiryDate":{"iso8601":"2017-07-21"},"issueCountry":"IN","issuedDate":{"iso8601":"2017-07-21"},"nationalityCountry":"IN","type":"REGULAR"}},{"ktn":{"number":"123456","issueCountry":"US"}}]
nameobject(Name)

Full name containing first, middle, last (family) names, and suffix.

phoneNumbersArray of objects(PhoneNumber)
profilePictureobject(Image)

An image with meta data. Either the data or url property must be supplied to load the image.

nationalitystring

Nationality of user

Example: "Indian"
titlestring(UserTitle)
Enum"TITLE_UNKNOWN""MR""MS""MRS""MX""MASTER""MISS""DR""PROFESSOR""CAPTAIN"
preferredLanguagestring

Language preferred by user.

Example: "en-US"
preferredPronounstring(PreferredPronoun)

Pronoun preferred by user.

Enum"SHE_HER_HERS""HE_HIM_HIS""THEY_THEM_THEIRS"
travelerNameobject(Name)

A name of user that does not contain special characters.

emergencyContactobject(EmergencyContact)

Emergency contact information.

emergencyContactInfoobject(EmergencyContactInfo)Deprecated

Emergency contact information.

Response
application/json
{
  "addresses": [
    { … }
  ],
  "dob": {
    "iso8601": "2017-07-21"
  },
  "email": "example@email.com",
  "emergencyContactInfo": {
    "address": { … },
    "designation": "MANAGER",
    "email": "emergency-contact@email.com",
    "name": { … },
    "phoneNumber": { … },
    "userOrgId": { … }
  },
  "gender": "FEMALE",
  "identityDocs": [
    { … },
    { … }
  ],
  "name": {
    "family1": "Gandas",
    "family2": "FamilyTwo",
    "given": "Vichitr",
    "middle": "Kumar",
    "suffix": "SR",
    "preferred": "Don"
  },
  "phoneNumbers": [
    { … }
  ],
  "profilePicture": {
    "data": "6935813e12584abda0e43d71cd2ea260",
    "dimensions": { … },
    "url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp"
  },
  "nationality": "Indian",
  "title": "MR",
  "preferredLanguage": "en-US",
  "preferredPronoun": "SHE_HER_HERS",
  "travelerName": {
    "family1": "Gandas",
    "family2": "FamilyTwo",
    "given": "Vichitr",
    "middle": "Kumar",
    "suffix": "SR",
    "preferred": "Don"
  },
  "emergencyContact": {
    "name": "John Smith",
    "email": "emergency-contact@email.com",
    "designation": "MANAGER",
    "relation": "SPOUSE",
    "phoneNumbers": [ … ],
    "preferredLanguage": "en-US"
  }
}
Copyright © 2025 Spotnana Technology, Inc.