InputParameters

InputParameters

FieldDescription
returnUrlstring the returnUrl in the request of Generate URL API
failReturnUrlstring the failReturnUrl in the request of Generate URL API
callbackUrlstring the callbackUrl in the request of Generate URL API
bizIdstring the bizId in the request of Generate URL API
userIdstring the userId in the request of Generate URL API
regionstring the region in the request of Generate URL API
languagestring The language in the request of Generate URL API
prefersColorSchemestring The prefersColorScheme in the request of Generate URL API
numberTypestring The numberType in the request of Generate URL API
scopestring[], optional for THAIEID. The effective attribute list used for the ThaID authorization. If Generate URL omitted scope or sent null, this returns ["idNumber", "firstName", "lastName", "birthday"]. A supplied scope is returned after whitespace trimming and deduplication. See Generate URL API.
ignoreFailWhenJumpbool The ignoreFailWhenJump in the request of Generate URL API
bizCodestring The bizCode in the request of Generate URL API
iframeEnabledbool The iframeEnabled in the request of Generate URL API

Examples

{
  "returnUrl": "https://www.example.com",
  "failReturnUrl": "https://www.example.com/fail",
  "callbackUrl": "https://www.example.com/callback",
  "bizId": "7ac66c0f148de9519b8bd264312c4d64",
  "userId": "8e44f0089b076e18a718eb9ca3d94674",
  "region": "IDN",
  "numberType": "NIK",
  "language": "en-US",
  "prefersColorScheme": "light",
  "ignoreFailWhenJump": false,
  "bizCode": "WhiteCard"
}
{
  "returnUrl": "https://www.example.com/verification/return",
  "failReturnUrl": "https://www.example.com/verification/failed",
  "bizId": "order-thaid-002",
  "userId": "user-thaid-002",
  "region": "THA",
  "numberType": "THAIEID",
  "scope": ["idNumber", "firstName", "lastName", "birthday"]
}

Did this page help you?