Skip to content

ConfigurationApi.md

Latest commit

 

History

History
529 lines (399 loc) · 20.2 KB

ConfigurationApi.md

File metadata and controls

529 lines (399 loc) · 20.2 KB

ConfigurationApi

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

Method HTTP request Description
getAllDatasources GET /configuration/v1/alldatasources/Identity Verification Gets all the datasources available, for when a specific country is not provided.
getConsents GET /configuration/v1/consents/{configurationName}/{countryCode} This method retrieves the consents required for data sources currently configured in your account configuration. The response for this method contains a collection of strings that Verify method's ConsentForDataSources field expects to perform a verification using those data sources. A failure to provide an element from the string collection will lead to a <a class=&quot;link-to-api&quot; href=&quot;#errors&quot;>1005</a> service error.
getCountryCodes GET /configuration/v1/countrycodes/{configurationName} This method retrieves all the countries that are available to perform a verification.
getCountrySubdivisions GET /configuration/v1/countrysubdivisions/{countryCode} Gets the provinces states or other subdivisions for a country, mostly matches ISO 3166-2
getDatasources GET /configuration/v1/datasources/{configurationName}/{countryCode} Gets datasource groups configured for your product and country.
getDetailedConsents GET /configuration/v1/detailedConsents/{configurationName}/{countryCode} This method retrieves details about consents required for data sources currently configured in your account configuration. The response for this method contains a collection of objects. Each object contains the Name of the data source, Text outlining what the user is consenting to, and optionally a Url where the user can find more information about how their data will be used. Failure to provide a Name from the object collection will lead to a <a class=&quot;link-to-api&quot; href=&quot;#errors&quot;>1005</a> service error.
getDocumentTypes GET /configuration/v1/documentTypes/{countryCode} Gets the document types available for a country.
getFields GET /configuration/v1/fields/{configurationName}/{countryCode} Generates json schema for the API, the schema is dynamic based on the country and configuration you are using. http://json-schema.org/documentation.html
getRecommendedFields GET /configuration/v1/recommendedfields/{configurationName}/{countryCode} Generates json schema for the API, the schema is dynamic based on the recommendedFields country and account you are using. http://json-schema.org/documentation.html
getTestEntities GET /configuration/v1/testentities/{configurationName}/{countryCode} Gets the test entities configured for your product and country.

getAllDatasources

List<NormalizedDatasourceGroupsWithCountry> getAllDatasources()

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.ConfigurationApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ConfigurationApi apiInstance = new ConfigurationApi();
try {
    List<NormalizedDatasourceGroupsWithCountry> result = apiInstance.getAllDatasources();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConfigurationApi#getAllDatasources");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

List<NormalizedDatasourceGroupsWithCountry>

Authorization

basic

getConsents

List<String> getConsents(countryCode, configurationName)

This method retrieves the consents required for data sources currently configured in your account configuration. The response for this method contains a collection of strings that Verify method's ConsentForDataSources field expects to perform a verification using those data sources. A failure to provide an element from the string collection will lead to a <a class=&quot;link-to-api&quot; href=&quot;#errors&quot;>1005</a> service error.

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.ConfigurationApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ConfigurationApi apiInstance = new ConfigurationApi();
String countryCode = "countryCode_example"; // String | Call CountryCodes to get the countries available to you.
String configurationName = "configurationName_example"; // String | Identity Verification
try {
    List<String> result = apiInstance.getConsents(countryCode, configurationName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConfigurationApi#getConsents");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
countryCode String Call CountryCodes to get the countries available to you.
configurationName String Identity Verification

Return type

List<String>

Authorization

basic

HTTP request headers

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

getCountryCodes

List<String> getCountryCodes(configurationName)

This method retrieves all the countries that are available to perform a verification.

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.ConfigurationApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ConfigurationApi apiInstance = new ConfigurationApi();
String configurationName = "configurationName_example"; // String | Identity Verification
try {
    List<String> result = apiInstance.getCountryCodes(configurationName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConfigurationApi#getCountryCodes");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
configurationName String Identity Verification

Return type

List<String>

Authorization

basic

HTTP request headers

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

getCountrySubdivisions

List<CountrySubdivision> getCountrySubdivisions(countryCode)

Gets the provinces states or other subdivisions for a country, mostly matches ISO 3166-2

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.ConfigurationApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ConfigurationApi apiInstance = new ConfigurationApi();
String countryCode = "countryCode_example"; // String | Country alpha2 code, get the the call to countrycodes
try {
    List<CountrySubdivision> result = apiInstance.getCountrySubdivisions(countryCode);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConfigurationApi#getCountrySubdivisions");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
countryCode String Country alpha2 code, get the the call to countrycodes

Return type

List<CountrySubdivision>

Authorization

basic

HTTP request headers

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

getDatasources

List<NormalizedDatasourceGroupCountry> getDatasources(configurationName, countryCode)

Gets datasource groups configured for your product and country.

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.ConfigurationApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ConfigurationApi apiInstance = new ConfigurationApi();
String configurationName = "configurationName_example"; // String | Identity Verification
String countryCode = "countryCode_example"; // String | Call CountryCodes to get the countries available to you.
try {
    List<NormalizedDatasourceGroupCountry> result = apiInstance.getDatasources(configurationName, countryCode);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConfigurationApi#getDatasources");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
configurationName String Identity Verification
countryCode String Call CountryCodes to get the countries available to you.

Return type

List<NormalizedDatasourceGroupCountry>

Authorization

basic

HTTP request headers

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

getDetailedConsents

List<Consent> getDetailedConsents(countryCode, configurationName)

This method retrieves details about consents required for data sources currently configured in your account configuration. The response for this method contains a collection of objects. Each object contains the Name of the data source, Text outlining what the user is consenting to, and optionally a Url where the user can find more information about how their data will be used. Failure to provide a Name from the object collection will lead to a <a class=&quot;link-to-api&quot; href=&quot;#errors&quot;>1005</a> service error.

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.ConfigurationApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ConfigurationApi apiInstance = new ConfigurationApi();
String countryCode = "countryCode_example"; // String | Call CountryCodes to get the countries available to you.
String configurationName = "configurationName_example"; // String | Identity Verification
try {
    List<Consent> result = apiInstance.getDetailedConsents(countryCode, configurationName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConfigurationApi#getDetailedConsents");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
countryCode String Call CountryCodes to get the countries available to you.
configurationName String Identity Verification

Return type

List<Consent>

Authorization

basic

HTTP request headers

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

getDocumentTypes

Map<String, List<String>> getDocumentTypes(countryCode)

Gets the document types available for a country.

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.ConfigurationApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ConfigurationApi apiInstance = new ConfigurationApi();
String countryCode = "countryCode_example"; // String | Call CountryCodes to get the countries available to you.
try {
    Map<String, List<String>> result = apiInstance.getDocumentTypes(countryCode);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConfigurationApi#getDocumentTypes");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
countryCode String Call CountryCodes to get the countries available to you.

Return type

Map<String, List<String>>

Authorization

basic

HTTP request headers

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

getFields

Object getFields(countryCode, configurationName)

Generates json schema for the API, the schema is dynamic based on the country and configuration you are using. http://json-schema.org/documentation.html

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.ConfigurationApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ConfigurationApi apiInstance = new ConfigurationApi();
String countryCode = "countryCode_example"; // String | Call CountryCodes to get the countries available to you.
String configurationName = "configurationName_example"; // String | Identity Verification
try {
    Object result = apiInstance.getFields(countryCode, configurationName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConfigurationApi#getFields");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
countryCode String Call CountryCodes to get the countries available to you.
configurationName String Identity Verification

Return type

Object

Authorization

basic

HTTP request headers

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

getRecommendedFields

Object getRecommendedFields(countryCode, configurationName)

Generates json schema for the API, the schema is dynamic based on the recommendedFields country and account you are using. http://json-schema.org/documentation.html

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.ConfigurationApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ConfigurationApi apiInstance = new ConfigurationApi();
String countryCode = "countryCode_example"; // String | Call CountryCodes to get the countries available to you.
String configurationName = "configurationName_example"; // String | Identity Verification
try {
    Object result = apiInstance.getRecommendedFields(countryCode, configurationName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConfigurationApi#getRecommendedFields");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
countryCode String Call CountryCodes to get the countries available to you.
configurationName String Identity Verification

Return type

Object

Authorization

basic

HTTP request headers

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

getTestEntities

List<DataFields> getTestEntities(configurationName, countryCode)

Gets the test entities configured for your product and country.

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.ConfigurationApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ConfigurationApi apiInstance = new ConfigurationApi();
String configurationName = "configurationName_example"; // String | Identity Verification
String countryCode = "countryCode_example"; // String | Call CountryCodes to get the countries available to you.
try {
    List<DataFields> result = apiInstance.getTestEntities(configurationName, countryCode);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConfigurationApi#getTestEntities");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
configurationName String Identity Verification
countryCode String Call CountryCodes to get the countries available to you.

Return type

List<DataFields>

Authorization

basic

HTTP request headers

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