Login and authorization

You can let users log in to your service with the user's DOSI account, using the User Account Connect API.

Connection info

Development environment	API base URI
Production	https://api.dosi.world

Instructions for use

Partner services must follow the next steps to allow DOSI users to log into the services or to get users' profile data.

You need a Gmail account to log into DOSI with your Google account. You can't use a Google Workspace account.

1. Request DOSI user authorization

Send an authorization request to the authorization endpoint (https://members.dosi.world). You must provide the following service information as query parameters.

Parameter	Description
client_id	DOSI channel ID received after applying for DOSI SDK
state	Random string for OAuth Flow verification
mode	OAuth Flow mode. Don't change the value from "oauth".
redirect_uri	Landing URI after user login
scope	Scope for the user profile group. Don't change the value from "basic".
code_challenge	Code challenge value in PKCE. Required if the client is a mobile app.
code_challenge_method	Method to generate code_challenge in PKCE. Required if the client is a mobile app. Don't change the value from "S256".

The following is an example of sending an authorization request.

https://members.dosi.world?client_id=17XEvciBbskwvvddn0m_&state=hiubweiriuqukjdsfsdrwe&mode=oauth&redirect_uri=https%3A%2F%2Fprofile.dosi.world%2F

When DOSI receives such a request, it moves to the service integration approval page (login page if the user isn't logged in). When the user approves the request, DOSI issues an authorization code to redirect_uri.

2. Issue access tokens

After Step 1, issue an access token using the authorization code. Use the Issue or refresh an access token endpoint.

3. Get user profiles

After Step 2, get user profiles using the access token. Use the Get extended user profile endpoint.

Issue or refresh an access token

Issues an access token with the authorization code or refreshes an access token with the refresh token.

POST {API base URI}/api/v1/oauth2/token

Request

Response

Path

None

Query

None

Body

Name	Type	Description	Required
grant_type	string	Request type. Either one of the two: "authorization_code": Request to issue an access token "refresh_token": Request to refresh an access token
code	string	An authorization code for the user who issued the access token. Provide this value only when grant_type is "authorization_code". You can get the authorization code with redirect_uri sent with the DOSI authorization request.
client_id	string	DOSI channel ID received after applying for DOSI SDK
client_secret	string	DOSI channel secret received after applying for DOSI SDK
refresh_token	string	A refresh token to refresh the access token. Provide this value only when grant_type is "refresh_token". A refresh token can be obtained when the access token is first issued by this endpoint. Use the latest refresh token only. Sending an expired refresh token will nullify all access tokens and refresh tokens according to the refresh token protection rules. If an expired refresh token is used, the user needs to be authorized again.
code_verifier	string	A random string generated for self-authorization by the client in PKCE. It must be a random value with high entropy. Refer to the reference. Required if the client is a mobile app.

Headers

• Content-Type: application/x-www-form-urlencoded

Request examples

Issuance request

Refresh request

curl -v -X POST "https://api.dosi.world/api/v1/oauth2/token" \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'grant_type=authorization_code' \
  -d 'code=b5fd32eacc791df' \
  -d 'client_id=12345' \
  -d 'client_secret=d6524edacc8742aeedf98f'

Name	Type	Description	Included
access_token	string	Access token issued
expires_in	number	Remaining seconds to the access_token expiration
refresh_token	string	Refresh token. Use this endpoint to refresh the access token. The token is valid for 90 days.
token_type	string	Token type. Always returns "Bearer".

Response status code

200 OK

Response headers

None

Related errors

• BAD_REQUEST
• AUTH_API_UNKNOWN
• AUTH_API_SERVER_ERROR

Response examples

Issuance request result

Refresh request result

{
  "access_token":"9b_7EjklljIR2EpqLA8D0ci1HftZSqsIfAMCUKMDKNWA44BGshJssw7lrZN1dQJ-ZNFJ-jd3hSO1MuLTt_2OSe2PXcL-IZwi7RinnoOzk0R_aw_BdoY9oKaBz_NGcNJBugUZPDntnHv8TH9cNpvZ8qjcElLa0B-5rcW0dreZFCA",
  "expires_in":604800,
  "refresh_token":"6201582b-050d-4120-9c84-7cb972b10e6a",
  "token_type":"Bearer"
}

Revoke the access token

Revokes the access token and refresh token.

POST {API base URI}/api/v1/oauth2/revoke

Request

Response

Path

None

Query

None

Body

None

Headers

• Authorization: Bearer <access token>
• Content-Type: application/json

Request examples

curl

curl -v -X POST "https://api.dosi.world/api/v1/oauth2/revoke" \
  --header 'Authorization: Bearer <access token>' \
  --header 'Content-Type: application/json'

None

Response status code

200 OK

Response headers

None

Related errors

• FAILED_TO_LOGOUT
• AUTH_API_UNKNOWN
• AUTH_API_SERVER_ERROR

Get extended user profile

Gets the user's extended profile with the access token.

GET {API base URI}/api/v2/profile/extended

Request

Response

Path

None

Query

None

Body

None

Headers

• Authorization: Bearer <access token>
• Content-Type: application/json

Request examples

curl

curl -v -X GET "https://api.dosi.world/api/v2/profile/extended" \
  --header 'Authorization: Bearer <access token>' \
  --header 'Content-Type: application/json'

Name	Type	Description	Included
userId	string	Unique ID for DOSI users in the regular expression format, [a-f0-9]{64}.
email	string	User's email address
pictureUrl	string	URL for user's profile picture
displayName	string	Display name set by the user
extended	object	Extended profile

Response status code

200 OK

Response headers

None

Related errors

None

Response examples

{
  "userId" : "6e06036d94598143a6b024aa45e97174da4a96fa06c743532d987c156d5f2d10",
  "email" : "mynameis@dosi.world",
  "pictureUrl" : "https://vos.line-scdn.net/global-nft-prod/profile-image/img_profile_default_02.png",
  "displayName" : "DosiUser1",
  "extended": {
    "walletAddress": "link1vhyua9t40fskhx7f72yesxgxaq5wcr57p2p5rp",
  }
}