Skip to content

Limits and Notes

The limits on this page apply to all organizations that integrate with the Taiwan Digital Identity Wallet (TW DIW, “the wallet” in this handbook) through TCS. For how engineers handle these cases, see Errors and Polling.

No test environment is available at this time. Acceptance tests run in production. Issuance and revocation have real effects.

The wallet shows only Turing Space Inc. as the verification requester and the issuer

Section titled “The wallet shows only Turing Space Inc. as the verification requester and the issuer”

In two places, the wallet shows Turing Space Inc., not your organization:

  • During verification: the verification requester on the wallet consent screen.
  • During issuance: the issuer on the credential.

You decide the name and the image on the card face of the credential. The card image can show your organization’s brand, so that holders can see from the card face that the credential is from your organization (see Getting Started). But the verification requester on the wallet consent screen and the issuer on the credential are still Turing Space Inc.

If your service requires your organization to appear in these two places, an integration through TCS cannot meet this requirement. Evaluate this before you decide to integrate. In your terms of service and in your information for holders, state that the verification requester and the issuer appear as Turing Space Inc.

Verification results are kept for about 5 minutes only

Section titled “Verification results are kept for about 5 minutes only”

After the holder completes the presentation, the verification result is kept for about 5 minutes. Then it is cleared.

After the result is cleared, you cannot get it. You must create a new verification and ask the holder to scan a new QR code. Read the result immediately after the holder completes the presentation. If you poll at the recommended interval, you usually get the result before it is cleared.

Results are not pushed to you, so your backend must query them

Section titled “Results are not pushed to you, so your backend must query them”

The results of issuances and verifications are not pushed to your system. Your backend must query for them while your screen shows the QR code. The recommended polling interval is 2 to 5 seconds.

If the recipient or the holder does not scan, or the wallet does not let the holder select a credential, the status stays pending (waiting) for the full timeout that you set. You must set your own timeout. The recommended value is 5 minutes.

  • Issuance: the timeout only closes your own waiting screen. It does not cancel the issuance. There is no feature to cancel an issuance at this time. The recipient (the holder after acceptance) may still accept the credential later with the original QR code. To handle this:
    • When you create the issuance, store the id, the QR code, and the mobile link from the response.
    • When the recipient comes back, first query this issuance with the id. If it is issued, store the cid. Do not issue again. If it is still waiting, show the original QR code or mobile link again. Do not create a new issuance.
    • If you must create a new issuance, and later both issuances show as issued, revoke the extra credential with its cid.
  • Verification: after the timeout, end this verification. If necessary, create a new verification.

Do not resend automatically after an error when you create an issuance

Section titled “Do not resend automatically after an error when you create an issuance”

When you create an issuance, you may get 502 or another 5xx (the TCS side did not complete the request). You may also get no response at all (for example, a timeout or a broken connection). In these cases, the issuance may already exist. If this issuance also revokes old credentials, the old credentials are revoked only when the recipient accepts the new credential. At this time, you cannot check through TCS API for DIW whether the issuance exists.

In these cases, do these steps:

  1. If your HTTP client, SDK, or API gateway automatically resends a request after it fails, turn off these automatic resends for the API that creates issuances. This prevents the same issuance from being created twice.
  2. Record the time you sent the request and the x-correlation-id / x-request-id value.
  3. Contact the TCS team with the request time and this value. The TCS team helps you check what happened.

Verification and revocation do not have this problem. You can resend when you get 502. When you resend a request to create a verification, you get a new id. Use the new QR code. When you resend a revoke request and get 400 with code 30205, the first request already revoked the credential. For what to do, see Revoke API.

At this time, three features are available: issuance, verification, and revoking a single credential. These features are not available:

  • Suspend a credential and recover it later. Revocation is permanent. You cannot restore the credential.
  • List the credentials that you issued. This feature is not available, so make sure that you store the cid in the issuance result. You need it to revoke the credential. Also store the id of each issuance as a fallback: if you did not store the cid, you can query with the id to get it again, but the query result is not guaranteed to stay available.
  • Revoke more than one credential at a time. The revoke API revokes only one credential in each request. The only exception is renewal (you issue a new credential and revoke old ones at the same time). In a renewal, one issuance request can revoke more than one old credential. See Issuance API.
  • Cancel an issuance that the recipient has not accepted yet.
  • List or search the issuance requests that you created. If you did not get an id when you created an issuance, you cannot find this issuance through the API.

If you need these features, contact the TCS team.

At this time, credential types and verification scenarios are not restricted to specific accounts. The TCS team gives you the codes. Do not make them public.