​API Endpoints and Functions

Public

​View Platform Statistics

https://api.sandbox.crowdvalley.com/v1/{network}/public/stats

Returns a set of global statistics about your platform's activities.
Implement this to show on your homepage, for example, the total amount raised on your platform.

Key Concepts:  Unauthenticated users | Filtering and sorting 

Response

Response

Create Account

https://api.sandbox.crowdvalley.com/v1/{network}/public/stats

Returns a set of global statistics about your platform's activities.
Implement this to show on your homepage, for example, the total amount raised on your platform.

Key Concepts:  Unauthenticated users | Filtering and sorting 

Response

Response

Verify Email

https://api.sandbox.crowdvalley.com/v1/{network}/public/verifyEmail

Validates a User's email address.
This function requires the parameters user_id and secret, which must be generated by calling POST /users or POST /self/resendVerificationEmail in advance of reaching the page from which POST /public/verifyEmail is called.
Successfully calling this function sets the User's email_verified flag to true.

Parameter	Required	Type	Format	Description
network	x	Path	String	The name of your network.
user_id	x	Body	Integer	The id of the User whose email is being verified by calling this function.
secret	x	Body	String	The secret string sent by the Crowd Valley Back Office to the User by email, after calling POST /users or POST /self/resendVerificationEmail.

Exception	HTTP Response	User Message	Developer Message
10017	400 (BAD REQUEST)	Failed to re-send verification email	Parameter missing: email
10018	400 (BAD REQUEST)	Failed to re-send verification email	Parameter missing: url
10019	404 (NOT FOUND)	Email address not recognized - please check that you have entered the correct email address without any typos	No User with this email address was found
10020	400 (BAD REQUEST)	Invalid email address - please check that you have entered the correct email address without any typos	​The User entered an invalid email address
10021	409 (CONFLICT)	​You have already verified your email address	The User already has email_verified set to true

Key Concepts:  Email Verification | User Onboarding | Unauthenticated User | Starter Functions

Sample Request

Response