User related

Create a User

Creates a new User.
It is strongly advised to store the kindlyUserId response field, as it is essential for most processes involving Users.

Method	URL	API key Authentication
POST	/PartnerServices/CreateUser	REQUIRED

Request Body Parameters

Field	Type	Required	Description	Format Allowed
firstName	String	✔	User's First Name.	Any string value
lastName	String	✔	User's Last Name.	Any string value
email	String	✔	User's Email Address. Details This value is used to authenticate our Users, so it must be unique across the database. If the email already exists, the existing User is returned.	Any string value
zipCode	String	✔	User's Zip Code.	Any string value
description	String	❌	Short description about the User.	Any string value
phoneNumber	String	❌	User's Phone Number.	Any string value
partnerOptInSource	String	❌	Indicate the source through which the User learned about Kindly.	Any string value

Example Request Body

{
  "firstName": "John",
  "lastName": "Doe",
  "email": "johndoe@gmail.com",
  "description": "John is a hard-working and driven individual who isn't afraid to face a challenge",
  "zipCode": "99501", // US valid ZIP code
  "phoneNumber": "1585301498",
  "partnerOptInSource": "website"
}

Response Status Codes

Status Code	Description
200 - OK	When the User was created or retrieved successfully.
400 - Bad Request	When the request is invalid or missing required parameters. Scenarios • Missing API key • Payload is not set • Missing required fields
401 - Unauthorized	When the API key is incorrect.
500 - Internal Server Error	When any exception occurred.

Success Response Format

Returns a JSON object containing details of the newly added User.

Field	Type	Description
kindlyUserId	String	User's ID. Details To execute more transactions for this User, you need to manage/store this ID.
firstName	String	User's First Name.
lastName	String	User's Last Name.
email	String	User's Email Address.
deeplink	String	A Firebase link that redirects to downloading the app and onboarding in the app. The partner can either generate a QR code and/or send it via email to the User.

Example Response Body

{
  "kindlyUserId": "10473963d373401fa1430096bfb38da7",
  "firstName": "John",
  "lastName": "Doe",
  "email": "johndoe@gmail.com",
  "deeplink": "https://kindlyapp.page.link/?link="
}

---

Get details of a User

Gets details of a User.
The User must have been part of at least one Event, or be enrolled by the partner.

Method	URL	API key Authentication
GET	/PartnerServices/GetUserDetails	REQUIRED

Request Query Parameters

Parameter	Type	Required	Description	Format Allowed
kindlyUserId	String	✔	User's ID.	Any string value

Example Query Parameters

?kindlyUserId=10473963d373401fa1430096bfb38da7

Response Status Codes

Status Code	Description
200 - OK	When the User details are retrieved successfully.
400 - Bad Request	When the request is invalid or missing required parameters. Scenarios • Missing API key • Missing required fields • User not found • User does not exist for Partner
401 - Unauthorized	When the API key is incorrect.
500 - Internal Server Error	When any exception occurred.

Success Response Format

Returns a JSON object containing information of the User.

Field	Type	Description
kindlyUserId	String	User's ID.
firstName	String	User's First Name.
lastName	String	User's Last Name.
email	String	User's Email Address.
zipCode	String	User's Location.
phoneNumber	String	User's Phone Number.
userImage	String	URL for the User's picture.
isMinor	Boolean	Whether the User is a minor.

Example Response Body

{
  "kindlyUserId": "10473963d373401fa1430096bfb38da7",
  "firstName": "John",
  "lastName": "Doe",
  "email": "johndoe@gmail.com",
  "zipCode": "99501",
  "phoneNumber": "1585301498",
  "userImage": "https://kindly-images-stage.azureedge.net/d7d59359b71a4880992c67af9f5ace86_1.jpeg?upscale=false&width=200",
  "isMinor": true
}