Identity

To retrieve a user's Identity, make the following HTTP request after retrieving a User Access Token:

Get identity by uuid. This allows polling the status of an identity

Get identity by uuid. This allows polling the status of an identity

GEThttps://api.global.id/v1/identities/me

Response

200404

Returns the identity record

Body

application/json

purpose_personalboolean

purpose_professionalboolean

purpose_recreationalboolean

display_namestring

gid_uuid*string (uuid)

gid_name*string

type*string

status*string

created_at*one of

string (date)string (date-time)

released_atone of

string (date)string (date-time)

completed*boolean

gid_name_moderation_status*string

public_signing_key*string

public_encryption_key*string

signup_typeenum

localidglobalid

is_private*boolean

has_wallet*boolean

descriptionstring

display_image_urlstring

region_codestring

region_namestring

country_codestring

country_namestring

state_codestring

state_namestring

metro_codestring

metro_namestring

encrypted_signup_challengestring

profile_picture_verifiedboolean

Request

JavaScriptCurl

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

Response

{
  "purpose_personal": false,
  "purpose_professional": false,
  "purpose_recreational": false,
  "display_name": "text",
  "gid_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "gid_name": "text",
  "type": "text",
  "status": "text",
  "created_at": "2024-04-16",
  "released_at": "2024-04-16",
  "completed": false,
  "gid_name_moderation_status": "text",
  "public_signing_key": "text",
  "public_encryption_key": "text",
  "signup_type": "localid",
  "is_private": false,
  "has_wallet": false,
  "description": "text",
  "display_image_url": "text",
  "region_code": "text",
  "region_name": "text",
  "country_code": "text",
  "country_name": "text",
  "state_code": "text",
  "state_name": "text",
  "metro_code": "text",
  "metro_name": "text",
  "encrypted_signup_challenge": "text",
  "profile_picture_verified": false
}