API Reference
Send verification code
POST https://ev.apis.paypi.dev/sendCode
This request send's a code to the given email address, which should be returned to check it is correct.
All emails are sent from [email protected]
Headers
Authorization*
string
PayPI subscriber secret in Bearer <token> format
Request Body
email*
string
The email address to send the verification code to
{
success: true,
message: "Verification email sent"
}{
success: false,
message:
"Unable to send email - please check the email address and try again"
}Check verification code
POST https://ev.apis.paypi.dev/checkCode
Checks the user's emailed code is valid.
If this returns success=true, you can safely assume the user you are interacting with is the owner of that email address.
Headers
Authorization*
string
PayPI subscriber secret in Bearer <token> format
Request Body
email*
string
The email address to check the code against
code*
string
The 6 digit code given by the user.
{
success: true,
message: "email successfully verified"
}{
success: false,
message: "Given code is not valid"
}To prevent abuse and brute forcing, we limit the number of checkCode requests for each email address to 20.
This means if more than 20 requests are made you will have to send another code to your user, this will reset the limit.
{
success: false,
message: "Number of tries exceeded, please request a new code"
}Last updated