Download the PHP package passbase/passbase-php without Composer
On this page you can find all versions of the php package passbase/passbase-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download passbase/passbase-php
More information about passbase/passbase-php
Files in passbase/passbase-php
Package passbase-php
Short Description # Introduction 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. In case of feedback or questions you can reach us under this email address: [[email protected]](mailto:[email protected]). A User submits a video selfie and valid identifying __Resources__ during a __Verification__ guided by the Passbase client-side integration. Once all the necessary __Resources__ are submitted, __Data points__ are extracted, digitized, and authenticated. These Data points then becomes part of the User's __Identity__. The User then consents to share __Resources__ and/or __Data points__ from their Identity with you. This information is passed to you and can be used to make decisions about a User (e.g. activate account). This table below explains our terminology further. | Term | Description | |-----------------------------------------|-------------| | [Identity](#tag/identity_model) | A set of Data points and Resources related to and owned by one single User. This data can be accessed by you through a Verification. | | Data points | Any data about a User extracted from a Resource (E.g. Passport Number, or Age). | | [Resource](#tag/resource_model) | A source document used to generate the Data points for a User (E.g. Passport). | | [User](#tag/user_model) | The owner of an email address associated with an Identity. | | Verification | A transaction through which a User consents to share Data points with you. If the Data points you request are not already available in the User's Identity, the Passbase client will ask the User to submit the necessary Resource required to extract them. | | Re-authentication (login) | A transaction through which a User can certify the ownership of Personal data previously shared through an Authentication. | # Authentication There are two forms of authentication for the API:
• API Key
• Bearer JWT Token
License unlicense
Homepage https://openapi-generator.tech
Informations about the package passbase-php
passbase
Introduction
<span class=\"subtext\"> 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.
In case of feedback or questions you can reach us under this email address: [email protected].
A User submits a video selfie and valid identifying Resources during a Verification guided by the Passbase client-side integration. Once all the necessary Resources are submitted, Data points are extracted, digitized, and authenticated. These Data points then becomes part of the User's Identity. The User then consents to share Resources and/or Data points from their Identity with you. This information is passed to you and can be used to make decisions about a User (e.g. activate account). This table below explains our terminology further.
Term | Description |
---|---|
Identity | A set of Data points and Resources related to and owned by one single User. This data can be accessed by you through a Verification. |
Data points | Any data about a User extracted from a Resource (E.g. Passport Number, or Age). |
Resource | A source document used to generate the Data points for a User (E.g. Passport). |
User | The owner of an email address associated with an Identity. |
Verification | A transaction through which a User consents to share Data points with you. If the Data points you request are not already available in the User's Identity, the Passbase client will ask the User to submit the necessary Resource required to extract them. |
Re-authentication (login) | A transaction through which a User can certify the ownership of Personal data previously shared through an Authentication. |
Authentication
<span class=\"subtext\">
There are two forms of authentication for the API:
• API Key
• Bearer JWT Token
Installation & Usage
Requirements
PHP 7.3 and later. Should also work with PHP 8.0 or 8.1 but has not been tested.
Composer
To install the bindings via Composer, add the following to composer.json
:
Then run composer install
Manual Installation
Download the files and include autoload.php
:
Getting Started
Please follow the installation procedure and then run the following:
API Endpoints
All URIs are relative to https://api.passbase.com/verification/v2
Class | Method | HTTP request | Description |
---|---|---|---|
IdentityApi | getIdentityById | GET /identities/{id} | Get identity |
IdentityApi | getIdentityResourceById | GET /identity/{id}/resources/{resource_id} | Get resource |
IdentityApi | getIdentityResourceFileById | GET /identity/{id}/resources/{resource_id}/resource_files/{resource_file_id} | Get resource file |
IdentityApi | listIdentities | GET /identities | List identities |
IdentityApi | listIdentityResources | GET /identity/{id}/resources | List resources |
ProjectApi | getSettings | GET /settings | Get project settings |
Models
- Cursor
- Identity
- IdentityOwner
- IdentityResource
- PaginatedIdentities
- PaginatedResources
- ProjectSettings
- ProjectSettingsCustomizations
- ProjectSettingsVerificationSteps
- Resource
- ResourceFile
- ResourceInput
- User
- WatchlistResponse
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
Tests
To run the tests, use:
Author
About this package
This PHP package is automatically generated by the OpenAPI Generator project:
- API version:
1.0.0
- Package version:
2.0.0
- Package version:
- Build package:
org.openapitools.codegen.languages.PhpClientCodegen
All versions of passbase-php with dependencies
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^7.3
guzzlehttp/psr7 Version ^1.7 || ^2.0