Check Verification Code
mocean.check_verify_code
ActionVoice & SMSconnection required
Calls the Mocean API with the connection's credentials.
Check the code the user typed back; a wrong code is reported, not raised as a step failure.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Mocean
- Secret shape
- {"api_token": "…"} — a Mocean API token, or {"api_key": "…", "api_secret": "…"}
- Config it needs
- base_url, sender_id, brand
- Resolved by
- config.connection_id, else node.connection_id
Configuration
2 fields, 2 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
reqid The verification request id that mocean.send_verify_code returned. | string | Yes | — | — | XXXXXXXXXXXXXXXXXXXXXX |
code The verification code the user entered, exactly as they typed it. | string | Yes | — | — | 123456 |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"code": "123456",
"reqid": "XXXXXXXXXXXXXXXXXXXXXX"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
verified True only when the code matched. | boolean | — |
status Mocean's status code: '0' matched, '16' no match, '15' too many attempts. | string | — |
err_msg Mocean's explanation when the code did not match. | string | — |
reqid The verification request the code was checked against. | string | — |
{
"err_msg": "",
"reqid": "",
"status": "",
"verified": false
}See Check Verification Code run in a workflow.
In a technical demo we add the Mocean connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.