Skip to main content
Version: 1.2.0-1.3.0

User linkage status validation

When processing user-related tasks or retrieving user information, the DOSI SDK pre-validates whether the user's wallet can handle the task. If the validation result indicates that the task cannot be processed, an error response is returned.

Partners can directly check the status before calling the API. Use the Get user linkage status endpoint.

User linkage status

The types of user statuses are as follows.

Status name

Description

API call restriction

Channel Linkage Available

The user has agreed to link with the partner's DOSI channel and can receive services. To achieve this status, the following two conditions must be met:

  • The DOSI user account is in normal status.
  • The user has agreed to link with the partner's DOSI channel.


No restrictions

No User Agreement

The user has not agreed to link with the partner's DOSI channel or has canceled the agreement, making it impossible to receive services.


Some API call restrictions

User Suspended

The user account is temporarily suspended and cannot receive services.


Some API call restrictions

User Unregistered

The user account has been deleted and cannot receive services.


API processing not possible

The types of user statuses may increase in the future.

Error response

If the API cannot be processed due to user status validation failure, the following error response is returned.

  • HTTP Status Code: 409 Conflict

  • HTTP Response Body (in JSON format)

    Name

    Type

    Description

    Notes

    responseCode

    String

    User status. One of the following:

    • NO_USER_AGREEMENT
    • USER_SUSPENDED
    • USER_UNREGISTERED

    Ignore statuses not listed in this document.

    The types of user statuses may increase in the future.

    errorMessage

    String

    Detailed error message

    This information is provided for explanation and may change without prior notice. Do not use this message for data processing in the client.

Response examples

Below are examples of responses when user status validation fails.

No User Agreement

{
"responseCode": "NO_USER_AGREEMENT",
"errorMessage": "*** This is a message for human readers, not for computers. ***"
}

User Suspended

{
"responseCode": "USER_SUSPENDED",
"errorMessage": "*** This is a message for human readers, not for computers. ***"
}

User Unregistered

{
"responseCode": "USER_UNREGISTERED",
"errorMessage": "*** This is a message for human readers, not for computers. ***"
}

Target endpoints

The table below shows when each endpoint for user linkage status validation can be executed per status.

EndpointChannel Linkage AvailableNo User AgreementUser SuspendedUser Unregistered
Get proxy status
Request proxy setup
Commit proxy setup request
Get user authorization status during proxy setup
Get digital item list (deprecated)
Get digital item list
Sealing
Batch sealing
Note

Note

Note

Note
Unsealing
Batch unsealing
Resealing
Get digital items on sale by user
Cancel digital item on sale by user
Get sale cancellation status

Conditions for executing batch sealing

If two or more user wallets are specified, the linkage status of all user wallets must meet the conditions to process the API.