Verify Security Code

Check if a security code sent via SMS Verify or Phone Verify is valid.

Note:
Security codes are only valid for 15 minutes after being generated and can only be verified from the same API key pair. This endpoint is rate limited at 1 request per second however for short verification codes additional brute-force protection can also be enable using the 'limit-by' option.

End Point

https://neutrinoapi.net/verify-security-code

API Request

Parameter	Required	Type	Default	Description
security-code	yes	string		The security code to verify
limit-by	no	string		If set then enable additional brute-force protection by limiting the number of attempts by the supplied value. This can be set to any unique identifier you would like to limit by, for example a hash of the users email, phone number or IP address. Requests to this API will be ignored after approximately 10 failed verification attempts

API Response

Parameter	Type	Description
verified	boolean	True if the code is valid

API Performance

Characteristic	Value	Description
Avg Latency	20ms	Average RTT for requests within the same data center/region
Max Rate	2/second	Maximum inbound request rate. Exceeding this will result in request throttling
Max Concurrency	10	Maximum concurrent/simultaneous requests. Exceeding this will result in error code 06 [TOO MANY CONNECTIONS]

API Example

curl https://neutrinoapi.net/verify-security-code \ --header "User-ID: <your-user-id>" \ --header "API-Key: <your-api-key>" \ --data-urlencode "security-code=123456" \ --data-urlencode "limit-by="

{ verified: false }