Git Product home page Git Product logo

aws-cdk-phone-verify-api's Introduction

Phone Verify API

This is an open source application designed to show the usage of modern serverless compute platforms such as AWS Lambda and DynamoDB. It is built and deployed using the AWS Cloud Development Kit.

This is a service that can be used by an application to check that a user is the owner of the phone number they provide.

Watch me build this application on YouTube

Architecture

Diagram

API

Start verification

When a user is validating their phone number, the service will send a 6 digit verification code by SMS and waits for their response.

Start Request:

POST /verify/start

{ "Phone": "+64223062141" }

Start Response:

{ "Id": "44c090cc-2ca0-491e-a4d0-dd2b2d4efadb" }

Check verification

The service checks the users input matches the code. If they match it marks the phone number as verified.

Check Request

POST /verify/check

{ "Id": "44c090cc-2ca0-491e-a4d0-dd2b2d4efadb", "Code": "654321" }

Check Response:

{ "Verified": true }

Verification Status

Use this endpoint to check the status of a verification.

Status Request

POST /verify/status

{ "Id": "44c090cc-2ca0-491e-a4d0-dd2b2d4efadb" }

Status Response:

{ "Verified": true }

Errors

Errors will be returned with a 400 status code and a simple error message.

{ "Error": "Phone required" }

Rate limiting

Start Verification

  • The top is 10 every half an hour, per phone number.

Check Verification

  • The top is 5 every day, per phone number.

Verification Status

  • The top is 60 per minute, per phone number.
  • The top is 180 per hour, per phone number.
  • The top is 250 per day, per phone number.

aws-cdk-phone-verify-api's People

Contributors

jakejscott avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

aws-cdk-phone-verify-api's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.