All URIs are relative to https://api.passbase.com/verification/v2
| Method | HTTP request | Description |
|---|---|---|
| GetIdentityById | Get /identities/{id} | Get identity |
| GetIdentityResourceById | Get /identity/{id}/resources/{resource_id} | Get resource |
| GetIdentityResourceFileById | Get /identity/{id}/resources/{resource_id}/resource_files/{resource_file_id} | Get resource file |
| ListIdentities | Get /identities | List identities |
| ListIdentityResources | Get /identity/{id}/resources | List resources |
Identity GetIdentityById(ctx, id) Get identity
Retrieve an identity by providing the identity ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | Unique ID of the identity to return |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Resource GetIdentityResourceById(ctx, id, resourceId) Get resource
Get a resource attached to an identity by providing the resource ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | Identity id | |
| resourceId | string | Resource id |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResourceFile GetIdentityResourceFileById(ctx, id, resourceId, resourceFileId) Get resource file
Get a raw resource file attached to an identity by providing the resource ID and the resource file ID. This is a protected route and you'll need a specific government authorization to access it.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | Identity id | |
| resourceId | string | Resource id | |
| resourceFileId | string | Resource file id |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PaginatedIdentities ListIdentities(ctx, optional) List identities
List all the identities retrievable by the provided API Secret Key.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *IdentityApiListIdentitiesOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a IdentityApiListIdentitiesOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| limit | optional.Int32 | ||
| cursor | optional.String |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PaginatedResources ListIdentityResources(ctx, id, optional) List resources
List resources attached to an identity by providing the identity ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | Identity id | |
| optional | *IdentityApiListIdentityResourcesOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a IdentityApiListIdentityResourcesOpts struct
| Name | Type | Description | Notes |
|---|
limit | optional.Int32| | cursor | optional.String| |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]