# Assinafy Authentication API

**Canonical:** https://apis.io/apis/assinafy-com-br/assinafy-com-br-authentication-api/  
**Provider:** Assinafy — https://apis.io/providers/assinafy-com-br/  
**Base URL:** https://api.assinafy.com.br  
**Documentation:** https://www.assinafy.com.br/api

Assinafy Authentication API is one of 14 APIs that [Assinafy](https://apis.io/providers/assinafy-com-br/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Authentication. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Authentication can be done in three ways: - API key in the `X-Api-Key` header: `X-Api-Key: {api-key}` - Access token in the `Authorization` header: `Authorization: Bearer {access-token}` - Access token as a URL parameter: `?access-token={access-token}` The **recommended** method is an API key, which you create from the settings page in the Assinafy app. An access token is obtained through login with email and password; it is a JWT that usually expires in one hour. Building an application that **other people** connect to their own workspace? Don't ask for their API key: use OAuth, which gives your app a token limited to what the user approved. See **OAuth Integration Guide**.

## Operations (15)

| Method | Path | Summary |
|---|---|---|
| POST | `/v1/login` | Login |
| PUT | `/v1/authentication/request-password-reset` | Request password reset |
| PUT | `/v1/authentication/reset-password` | Reset password |
| PUT | `/v1/authentication/change-password` | Change password |
| POST | `/v1/authentication/mfa/verify` | Complete a two-factor login |
| GET | `/v1/users/self/mfa` | List two-factor methods |
| POST | `/v1/users/self/mfa/totp` | Start authenticator enrollment |
| PUT | `/v1/users/self/mfa/totp/confirm` | Confirm authenticator enrollment |
| POST | `/v1/users/self/mfa/recovery-codes` | Regenerate recovery codes |
| DELETE | `/v1/users/self/mfa/{customId}` | Remove a two-factor method |
| POST | `/v1/authentication/social-login` | Social login |
| POST | `/v1/auth/link-social-login` | Link social login |
| GET | `/v1/users/api-keys` | Get API key |
| POST | `/v1/users/api-keys` | Create API key |
| DELETE | `/v1/users/api-keys` | Delete API key |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/assinafy-com-br/openapi/assinafy-com-br-authentication-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/assinafy-com-br/json-schema/assinafy-com-br-document-contract-input-schema.json
- **JSONSchema** — https://artifacts.apis.io/assinafy-com-br/json-schema/assinafy-com-br-document-schema.json
- **JSONSchema** — https://artifacts.apis.io/assinafy-com-br/json-schema/assinafy-com-br-document-contract-amendment-schema.json
- **JSONSchema** — https://artifacts.apis.io/assinafy-com-br/json-schema/assinafy-com-br-signer-identity-review-schema.json
- **JSONSchema** — https://artifacts.apis.io/assinafy-com-br/json-schema/assinafy-com-br-document-contract-schema.json
- **JSONSchema** — https://artifacts.apis.io/assinafy-com-br/json-schema/assinafy-com-br-webhook-dispatch-schema.json

## Other Assinafy APIs (12)

- [Assinafy Accounts API](https://apis.io/apis/assinafy-com-br/assinafy-com-br-accounts-api/)
- [Assinafy Assignments API](https://apis.io/apis/assinafy-com-br/assinafy-com-br-assignments-api/)
- [Assinafy Contracts API](https://apis.io/apis/assinafy-com-br/assinafy-com-br-contracts-api/)
- [Assinafy Documents API](https://apis.io/apis/assinafy-com-br/assinafy-com-br-documents-api/)
- [Assinafy Fields API](https://apis.io/apis/assinafy-com-br/assinafy-com-br-fields-api/)
- [Assinafy OAuth API](https://apis.io/apis/assinafy-com-br/assinafy-com-br-oauth-api/)
- [Assinafy Signers API](https://apis.io/apis/assinafy-com-br/assinafy-com-br-signers-api/)
- [Assinafy Signing API](https://apis.io/apis/assinafy-com-br/assinafy-com-br-signing-api/)
- [Assinafy Tags API](https://apis.io/apis/assinafy-com-br/assinafy-com-br-tags-api/)
- [Assinafy Templates API](https://apis.io/apis/assinafy-com-br/assinafy-com-br-templates-api/)
- [Assinafy Users API](https://apis.io/apis/assinafy-com-br/assinafy-com-br-users-api/)
- [Assinafy Webhook Payloads API](https://apis.io/apis/assinafy-com-br/assinafy-com-br-webhook-payloads-api/)

## Tags

Authentication

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/assinafy-com-br/assinafy-com-br-authentication-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/assinafy-com-br/.
