Vulos Documentation
  • Identity
    • Welcome to the Vulos Identity Documentation!
    • Quick Start
    • Organizations
    • Scopes and Claims
  • Reference
    • Identity JavaScript SDK
      • The Base Package
        • KYC
          • KycStatus
          • KycInstance
          • KycDetails
          • KycApi
        • Profile
          • UserReference
          • ProfileApi
        • Cache
        • Authentication
          • Application
          • BaseAuth
          • User
          • UserInfo
          • BaseApi
        • Organizations
          • Organization
          • OrganizationMembership
            • OrganizationMembershipWithMetadata
          • OrganizationRole
          • OrganizationApi
      • The Backend Auth Package
        • CodeVerifier
        • BackendAuth
      • The Frontend Auth Package
        • IFrameRefresh
        • StateVerifier
        • FrontendAuth
    • Organization API
      • Organizations
      • Memberships
        • Roles
    • Profile API
    • KYC API
Powered by GitBook
On this page
  • User Profile
  • Organization Profile
  • Search Organizations
  1. Reference

Profile API

Get information about a specific user using this API.

PreviousRolesNextKYC API

Last updated 3 years ago

If you use the you could use the abstraction instead.

You need the scope to access this API.

User Profile

GET https://identity.vulos.io/api/v1/profile/:id

Get the user's public profile information.

Path Parameters

Name
Type
Description

id*

String

The user's ID

Headers

Name
Type
Description

Authorization*

String

Bearer authentication with the access token obtained using OpenID Connect

{
    "error": "Something went wrong",
    "code": "<errror code>",
    "request": "<request id>"
}
{
    "firstName": "John",
    "lastName": "Doe"
}

Organization Profile

GET https://identity.vulos.io/api/v1/profile/organization/:id

Get the organization's public profile information.

Path Parameters

Name
Type
Description

id*

String

The ID of the organization

Headers

Name
Type
Description

Authorization*

String

Bearer authentication with the access token obtained using OpenID Connect

{
    "name": "Example",
    "address": "Example Address",
    "city": "Example Test",
    "country": "Example Country Name",
    "state": "Example State Name",
    "website": "https://example.com",
    "verified": false,
    "uniqueId": "<example unique id>",
    "zipCode": "<example zip code>"
}
{
    "error": "Something went wrong",
    "code": "<errror code>",
    "request": "<request id>"
}

Search Organizations

GET https://identity.vulos.io/api/v1/profile/organization/search/:search/:amount/:offset

Search for an organization by name.

Path Parameters

Name
Type
Description

search*

String

The keyword to find in the organization's name

amount

String

The maximal amount of organizations to return (defaults to 10, it's limited to 100)

offset

String

The amount of organizations to skip (defaults to 0)

Headers

Name
Type
Description

Authorization*

String

Bearer authentication with the access token obtained using OpenID Connect

[
    {
        "id": 1,
        "name": "Example"
        // additional public profile data
    },
    {
        "id": 2,
        "name": "Scond Example"
    }
]

JavaScript SDK
ProfileApi
profile:read