Directory

Resources you can use to get more information about the user that just finished login in with GlobaliD.

Get the public profile information of the identity by subject

GEThttps://api.global.id/v1/directory/{sub}

Path parameters

sub*string

Subject of the token

Response

200404

Public profile information of the identity

Body

application/json

gid_uuidstring

GlobaliD UUID equal to the sub claim in the access token

namestring

Universal name of the user equal to the globalid claim in the access token

display_namestring

Display name of the user

profile_photostring

Image UUID of the user's profile photo

created_atstring (date-time)

Date and time the user was created

public_keystring

Public key of the user ( ED25519 in base58 encoding )

country_codestring

Country code of the user - ISO 3166-1 alpha-2

typestring

Type of the user

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.global.id/v1/directory/{sub}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "gid_uuid": "text",
  "name": "text",
  "display_name": "text",
  "profile_photo": "text",
  "created_at": "2025-01-26T05:20:29.976Z",
  "public_key": "text",
  "country_code": "text",
  "type": "USER"
}

Get the public profile information of the identity by globalid

GEThttps://api.global.id/v1/directory/profile/{globalid}

Path parameters

globalid*string

GlobaliD of the user, can be retrieved from the globalid claim in the access token

Response

200404

Public profile information of the identity

Body

application/json

gid_uuidstring

GlobaliD UUID equal to the sub claim in the access token

namestring

Universal name of the user equal to the globalid claim in the access token

display_namestring

Display name of the user

profile_photostring

Image UUID of the user's profile photo

created_atstring (date-time)

Date and time the user was created

public_keystring

Public key of the user ( ED25519 in base58 encoding )

country_codestring

Country code of the user - ISO 3166-1 alpha-2

typestring

Type of the user

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.global.id/v1/directory/profile/{globalid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "gid_uuid": "text",
  "name": "text",
  "display_name": "text",
  "profile_photo": "text",
  "created_at": "2025-01-26T05:20:29.976Z",
  "public_key": "text",
  "country_code": "text",
  "type": "USER"
}

Get the public profile image of the identity by subject

GEThttps://api.global.id/v1/directory/{sub}/avatar

Path parameters

sub*string

Subject of the access token

Response

302404

Redirect to the provided redirect_uri with an authorization code

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.global.id/v1/directory/{sub}/avatar', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

API definitions in a OpenAPI file:

4KB

directory.yml

OpenAPI file