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

Name	Type	Description
Authorization*	string	PayPI subscriber secret in Bearer <token> format

Request Body

Name	Type	Description
email*	string	The email address to send the verification code to

200: OK Success - Email sent

{
    success: true,
    message: "Verification email sent"
}

400: Bad Request Invalid or incorrectly formatted email given

401: Unauthorized Invalid API Key

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

Name	Type	Description
Authorization*	string	PayPI subscriber secret in Bearer <token> format

Request Body

Name	Type	Description
email*	string	The email address to check the code against
code*	string	The 6 digit code given by the user.

200: OK Success - Code Correct

{
      success: true,
      message: "email successfully verified"
}

401: Unauthorized Invalid API Key

200: OK Unable to verify email - Code incorrect

403: Forbidden Tries Exceeded

4KB

openapi.yaml

Open