1.3.1 • Published 2 years ago
@passbase/node v1.3.1
Passbase Node SDK
Welcome to the Passbase Verifications API docs. This documentation will help you understand our models and the Verification API with its endpoints. Based on this you can build your own system (i.e. verification) and hook it up to Passbase.
This package is a client meant to be used on the server-side to communicate with Passbase servers. You can find more information here: https://docs.passbase.com/server/api
Example how to use the SDK
const {
PassbaseClient,
PassbaseConfiguration,
ResponseFormats,
} = require("@passbase/node");
async function main() {
const apiKey = "[redacted]";
const config = new PassbaseConfiguration({
apiKey,
format: ResponseFormats.Json,
});
const client = new PassbaseClient(config);
const settings = await client.getSettings();
console.log(JSON.stringify(settings, null, 4));
}
main().catch(err => {
console.error(err);
process.exit(1);
});
Documentation for API Endpoints
All URIs are relative to https://api.passbase.com/verification/v2
Class | Method | HTTP request | Description |
---|---|---|---|
VerificationApi.IdentityApi | getIdentityById | GET /identities/{id} | Get identity |
VerificationApi.IdentityApi | getIdentityResourceById | GET /identity/{id}/resources/{resource_id} | Get resource |
VerificationApi.IdentityApi | getIdentityResourceFileById | GET /identity/{id}/resources/{resource_id}/resource_files/{resource_file_id} | Get resource file |
VerificationApi.IdentityApi | listIdentities | GET /identities | List identities |
VerificationApi.IdentityApi | listIdentityResources | GET /identity/{id}/resources | List resources |
VerificationApi.ProjectApi | getSettings | GET /settings | Get project settings |
Documentation for Models
- VerificationApi.Cursor
- VerificationApi.Identity
- VerificationApi.IdentityOwner
- VerificationApi.IdentityResource
- VerificationApi.PaginatedIdentities
- VerificationApi.PaginatedResources
- VerificationApi.ProjectSettings
- VerificationApi.ProjectSettingsCustomizations
- VerificationApi.ProjectSettingsVerificationSteps
- VerificationApi.Resource
- VerificationApi.ResourceFile
- VerificationApi.ResourceInput
- VerificationApi.User
- VerificationApi.WatchlistResponse
Documentation for Authorization
IdentityAccessToken
- Type: Bearer authentication (JWT)
PublishableApiKey
- Type: API key
- API key parameter name: X-API-KEY
- Location: HTTP header
SecretApiKey
- Type: API key
- API key parameter name: X-API-KEY
- Location: HTTP header