Skip to content

ConnectionApi.md

Latest commit

 

History

History
145 lines (102 loc) · 4.7 KB

ConnectionApi.md

File metadata and controls

145 lines (102 loc) · 4.7 KB

ConnectionApi

All URIs are relative to https://api.trulioo.com

Method HTTP request Description
connectionAsyncCallbackUrl POST /connection/v1/async-callback If set, the transaction will run asynchronously and Trulioo will try to update the client with transaction state updates until completed. If callback is not desired but the client wants to initiate an asynchronous transaction, provide https://api.trulioo.com/connection/v1/async-callback as the Callback URL.
sayHello GET /connection/v1/sayhello/{name} This method enables you to check if your system can connect to our system. You can even use a web browser to verify a connection to our system.
testAuthentication GET /connection/v1/testauthentication This method enables you to check if your credentials are valid. You will need to use basic authentication to ensure a successful response.

connectionAsyncCallbackUrl

Object connectionAsyncCallbackUrl(transactionStatus)

If set, the transaction will run asynchronously and Trulioo will try to update the client with transaction state updates until completed. If callback is not desired but the client wants to initiate an asynchronous transaction, provide https://api.trulioo.com/connection/v1/async-callback as the Callback URL.

Example

// Import classes:
//import com.trulioo.normalizedapi.ApiException;
//import com.trulioo.normalizedapi.api.ConnectionApi;


ConnectionApi apiInstance = new ConnectionApi();
TransactionStatus transactionStatus = new TransactionStatus(); // TransactionStatus | transactionStatus
try {
    Object result = apiInstance.connectionAsyncCallbackUrl(transactionStatus);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConnectionApi#connectionAsyncCallbackUrl");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
transactionStatus TransactionStatus transactionStatus

Return type

Object

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, text/json
  • Accept: application/json, text/json

sayHello

String sayHello(name)

This method enables you to check if your system can connect to our system. You can even use a web browser to verify a connection to our system.

Example

// Import classes:
//import com.trulioo.normalizedapi.ApiException;
//import com.trulioo.normalizedapi.api.ConnectionApi;


ConnectionApi apiInstance = new ConnectionApi();
String name = "name_example"; // String | Name to be returned in the response
try {
    String result = apiInstance.sayHello(name);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConnectionApi#sayHello");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
name String Name to be returned in the response

Return type

String

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json

testAuthentication

String testAuthentication()

This method enables you to check if your credentials are valid. You will need to use basic authentication to ensure a successful response.

Example

// Import classes:
//import com.trulioo.normalizedapi.ApiClient;
//import com.trulioo.normalizedapi.ApiException;
//import com.trulioo.normalizedapi.Configuration;
//import com.trulioo.normalizedapi.auth.*;
//import com.trulioo.normalizedapi.api.ConnectionApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ConnectionApi apiInstance = new ConnectionApi();
try {
    String result = apiInstance.testAuthentication();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConnectionApi#testAuthentication");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json