prove-sdk-server-dotnet

.NET Server SDK for Prove APIs - Customer Access

Summary

Prove APIs: This specification describes the Prove API.

OpenAPI Spec - generated.

Table of Contents

• prove-sdk-server-dotnet
  • SDK Installation
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Error Handling
  • Server Selection

SDK Installation

NuGet

To add the NuGet package to a .NET project:

dotnet add package Prove.Proveapi

Locally

To add a reference to a local instance of the SDK in a .NET project:

dotnet add reference src/Prove/Proveapi/Prove.Proveapi.csproj

SDK Example Usage

Example

using Prove.Proveapi;
using Prove.Proveapi.Models.Components;

var sdk = new ProveAPI(auth: "<YOUR_AUTH_HERE>");

V3StartRequest req = new V3StartRequest() {
    AllowOTPRetry = true,
    Dob = "1981-01",
    EmailAddress = "mpinsonm@dyndns.org",
    FinalTargetUrl = "https://www.example.com/landing-page",
    FlowType = "mobile",
    IpAddress = "10.0.0.1",
    PhoneNumber = "2001001695",
    SmsMessage = "#### is your temporary code to continue your application. Caution: for your security, don't share this code with anyone.",
    Ssn = "0596",
};

var res = await sdk.V3.V3StartRequestAsync(req);

// handle response

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
Auth	oauth2	OAuth2 token

To authenticate with the API the Auth parameter must be set when initializing the SDK client instance. For example:

using Prove.Proveapi;
using Prove.Proveapi.Models.Components;

var sdk = new ProveAPI(auth: "<YOUR_AUTH_HERE>");

V3TokenRequest req = new V3TokenRequest() {
    ClientId = "customer_id",
    ClientSecret = "secret",
    GrantType = "client_credentials",
};

var res = await sdk.V3.V3TokenRequestAsync(req);

// handle response

Available Resources and Operations

Available methods

Identity

• V3BatchGetIdentities - Batch Get Identities
• V3EnrollIdentity - Enroll Identity
• V3BatchEnrollIdentities - Batch Enroll Identities
• V3DisenrollIdentity - Disenroll Identity
• V3GetIdentity - Get Identity
• V3ActivateIdentity - Activate Identity
• V3DeactivateIdentity - Deactivate Identity
• V3GetIdentitiesByPhoneNumber - Get Identities By Phone Number

V3

• V3TokenRequest - Request OAuth Token
• V3ChallengeRequest - Submit Challenge
• V3CompleteRequest - Complete Flow
• V3StartRequest - Start Flow
• V3UnifyRequest - Initiate Possession Check
• V3UnifyBindRequest - Bind Prove Key
• V3UnifyStatusRequest - Check Status
• V3ValidateRequest - Validate Phone Number
• V3VerifyRequest - Initiate Verified Users Session
• V3VerifyStatusRequest - Check Verification Result

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or throw an exception.

By default, an API error will raise a Prove.Proveapi.Models.Errors.APIException exception, which has the following properties:

Property	Type	Description
Message	string	The error message
Request	HttpRequestMessage	The HTTP request
Response	HttpResponseMessage	The HTTP response

When custom error responses are specified for an operation, the SDK may also throw their associated exceptions. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the V3TokenRequestAsync method throws the following exceptions:

Error Type	Status Code	Content Type
Prove.Proveapi.Models.Errors.Error400	400	application/json
Prove.Proveapi.Models.Errors.Error401	401	application/json
Prove.Proveapi.Models.Errors.Error	500	application/json
Prove.Proveapi.Models.Errors.APIException	4XX, 5XX	*/*

Example

using Prove.Proveapi;
using Prove.Proveapi.Models.Components;
using Prove.Proveapi.Models.Errors;

var sdk = new ProveAPI();

try
{
    V3TokenRequest req = new V3TokenRequest() {
        ClientId = "customer_id",
        ClientSecret = "secret",
        GrantType = "client_credentials",
    };

    var res = await sdk.V3.V3TokenRequestAsync(req);

    // handle response
}
catch (Exception ex)
{
    if (ex is Error400)
    {
        // Handle exception data
        throw;
    }
    else if (ex is Error401)
    {
        // Handle exception data
        throw;
    }
    else if (ex is Error)
    {
        // Handle exception data
        throw;
    }
    else if (ex is Prove.Proveapi.Models.Errors.APIException)
    {
        // Handle default exception
        throw;
    }
}

Server Selection

Select Server by Name

You can override the default server globally by passing a server name to the server: string optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:

Name	Server	Description
uat-us	https://platform.uat.proveapis.com	UAT for US Region
prod-us	https://platform.proveapis.com	Prod for US Region
uat-eu	https://platform.uat.eu.proveapis.com	UAT for EU Region
prod-eu	https://platform.eu.proveapis.com	Prod for EU Region

Example

using Prove.Proveapi;
using Prove.Proveapi.Models.Components;

var sdk = new ProveAPI(server: SDKConfig.Server.ProdEu);

V3TokenRequest req = new V3TokenRequest() {
    ClientId = "customer_id",
    ClientSecret = "secret",
    GrantType = "client_credentials",
};

var res = await sdk.V3.V3TokenRequestAsync(req);

// handle response

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverUrl: string optional parameter when initializing the SDK client instance. For example:

using Prove.Proveapi;
using Prove.Proveapi.Models.Components;

var sdk = new ProveAPI(serverUrl: "https://platform.uat.proveapis.com");

V3TokenRequest req = new V3TokenRequest() {
    ClientId = "customer_id",
    ClientSecret = "secret",
    GrantType = "client_credentials",
};

var res = await sdk.V3.V3TokenRequestAsync(req);

// handle response