# Confirmation API

The Tidepool API is an HTTP REST API used by Tidepool clients use to communicate with the Tidepool Platform.

For more information, see the [Getting Started](../docs/quick-start.md) section.

Version: 1.0
License: BSD-2-Clause

## Servers

integration
```
https://external.integration.tidepool.org
```

production
```
https://api.tidepool.org
```

dev1
```
https://dev1.dev.tidepool.org
```

qa1
```
https://qa1.development.tidepool.org
```

qa2
```
https://qa2.development.tidepool.org
```

## Security

### sessionToken

Tidepool Session Token

Type: apiKey
In: header
Name: X-Tidepool-Session-Token

## Download OpenAPI description

[Confirmation API](https://tidepool.redocly.app/_spec/reference/confirm.v1.yaml)

## Confirmations

Manage confirmations for account creation, sharing invites, etc.

### Send Account Signup Confirmation

 - [POST /confirm/send/signup/{userId}](https://tidepool.redocly.app/reference/confirm.v1/confirmations/sendaccountsignupconfirmation.md): Sends account signup confirmation email.

### Resend account signup confirmation email

 - [POST /confirm/resend/signup/{email}](https://tidepool.redocly.app/reference/confirm.v1/confirmations/resendaccountsignup.md): If a user didn't receive the confirmation email and logs in, they're directed to the confirmation-required page which can offer to resend the confirmation email.

### Accept Account Signup

 - [PUT /confirm/accept/signup/{key}](https://tidepool.redocly.app/reference/confirm.v1/confirmations/confirmaccountsignup.md): Marks the account as having been verified. This would be PUT by the web page at the link in the signup email.

### Dismiss Account Signup

 - [PUT /confirm/dismiss/signup/{userId}](https://tidepool.redocly.app/reference/confirm.v1/confirmations/dismissaccountsignup.md): In the event that someone uses the wrong email address, the receiver could explicitly dismiss a signup

### Get Account Signup Confirmation

 - [GET /confirm/signup/{userId}](https://tidepool.redocly.app/reference/confirm.v1/confirmations/getaccountsignupconfirmation.md): Fetch latest account signup confirmation for the provided userId

### Upsert Account Signup Confirmation

 - [POST /confirm/signup/{userId}](https://tidepool.redocly.app/reference/confirm.v1/confirmations/upsertaccountsignupconfirmation.md): Add or refresh an account signup confirmation for the provided userId

### Cancel Account Signup

 - [PUT /confirm/signup/{userId}](https://tidepool.redocly.app/reference/confirm.v1/confirmations/cancelaccountsignupconfirmation.md): Cancels the account signup.

### Send Password Reset Email

 - [POST /confirm/forgot/{email}](https://tidepool.redocly.app/reference/confirm.v1/confirmations/sendpasswordreset.md): If the request is correctly formed, always returns a 200, even if the email address was not found (this way it can't be used to validate email addresses).
If the email address is found in the Tidepool system, this will:
  - Create a confirm record and a random key
  - Send an email with a link containing the key

### Accept password change

 - [PUT /confirm/accept/forgot](https://tidepool.redocly.app/reference/confirm.v1/confirmations/acceptpasswordchange.md): Accept the password change
This endpoint will be invoked by the lost password screen with the key that was included in the URL of the lost password screen.

### Send Invitation to Join Care Team

 - [POST /confirm/send/invite/{userId}](https://tidepool.redocly.app/reference/confirm.v1/confirmations/sendcareteaminvite.md): Sends an invitation to join the care team of the user identified by .

### Accept Invitation to Join Care Team

 - [PUT /confirm/accept/invite/{userId}/{invitedBy}](https://tidepool.redocly.app/reference/confirm.v1/confirmations/acceptcareteaminvite.md): Accepts the invitation to join a care team.

### Get Pending Care Team Invitations

 - [GET /confirm/invite/{userId}](https://tidepool.redocly.app/reference/confirm.v1/confirmations/getsentinvitations.md): Returns the still-pending invitations for an account you own or are an admin of.
These are the invitations you have sent that have not been accepted. There is no way to tell if an invitation has been ignored.

### Get Received Care Team Invitations

 - [GET /confirm/invitations/{userId}](https://tidepool.redocly.app/reference/confirm.v1/confirmations/getreceivedinvitations.md): Get list of received invitations for logged in user. These are invitations that have been sent to this user but not yet acted upon.

### Dismiss Care Team Invitation

 - [PUT /confirm/dismiss/invite/{userId}/{invitedBy}](https://tidepool.redocly.app/reference/confirm.v1/confirmations/dismissinvite.md): Declines the invitation to join a care team.

### Cancel Care Team Invitation

 - [PUT /confirm/{userId}/invited/{invitedBy}](https://tidepool.redocly.app/reference/confirm.v1/confirmations/cancelinvite.md): Cancels an invitation that has been sent to an email address.