Verify User-submitted Code

Request URI

/v1/verify

HTTP Method

POST

Request Format

application/json

Request Parameters

Parameter	Type	Required/Default	Example Value	Description
service_id	str	Required	568ff29ec61a2ee7ead4ebd1c026e128	Service ID
gen_time	int	Required	1710496502	Current timestamp, in seconds
signature	str	Required	6197126a0d9ccb9e818deca9c7f165962df88e3a6ce2a1856fe7f42463e89d03	Signature, see signing method
to	str	Required	+6591201234	Recipient, currently only mobile
verification_code	str	Required	123456	Verification code to be validated
channel	str	Optional, default "sms"	sms	Delivery channel, currently only "sms"
sms_template_id	str	Required if channel is "sms"	207406	SMS template ID

Request Example

{
    "service_id": "568ff29ec61a2ee7ead4ebd1c026e128",
    "signature": "a653fc27612471123ecfa98dde803dffc074e4b46d3a4139e880b8706c22a186",
    "gen_time": 1710994947,
    "to": "+6591201234",
    "sms_template_id": "207406",
    "verification_code": "33009373"
}

Response Format

application/json

Response Parameters

Parameter	Type	Required	Description
request_id	str	Yes	Unique identifier for this request
status	str	Yes	"success" or "error"
error_code	int	Required if status is "error"	Error code
error_msg	str	Required if status is "error"	Error message
service_id	str	Required if status is "success"	Service ID, same as request posted
valid	boolean	Required if status is "success"	Validation result

Response Examples

Code Valid Example

{
    "status": "success",
    "channel": "sms",
    "request_id": "gs3chhyv3m6vpssjd1f28za91u041wa0",
    "service_id": "568ff29ec61a2ee7ead4ebd1c026e128",
    "valid": true
}

Code Invalid Example

{
    "status": "success",
    "channel": "sms",
    "request_id": "9ksthahrzu10z87gt75gj2kdp3pljrkh",
    "service_id": "568ff29ec61a2ee7ead4ebd1c026e128",
    "valid": false
}