public class IdentitiesApi
extends Object

Nested Class Summary

Nested Classes
Modifier and Type Class Description

class IdentitiesApi.APIlistIdentitiesRequest

class IdentitiesApi.APIlistIdentityAssociatedIdentitiesRequest

Constructor Summary

Constructors
Constructor Description

IdentitiesApi()

IdentitiesApi(FinixClient finixClient)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Identity`	`create(CreateIdentityRequest createIdentityRequest)`	Create an Identity Create an `Identity` for your merchant or buyer.
`Identity`	`createAssociatedIdentity(String identityId, CreateAssociatedIdentityRequest createAssociatedIdentityRequest)`	Create an Associated Identity Create an associated `Identity` for [every owner with 25% or more ownership](/guides/onboarding/#step-3-add-associated-identities) over the merchant.
`okhttp3.Call`	`createAssociatedIdentityAsync(String identityId, CreateAssociatedIdentityRequest createAssociatedIdentityRequest, ApiCallback<Identity> _callback)`	Create an Associated Identity (asynchronously) Create an associated `Identity` for [every owner with 25% or more ownership](/guides/onboarding/#step-3-add-associated-identities) over the merchant.
`okhttp3.Call`	`createAssociatedIdentityCall(String identityId, CreateAssociatedIdentityRequest createAssociatedIdentityRequest, ApiCallback _callback)`	Build call for createAssociatedIdentity
`ApiResponse<Identity>`	`createAssociatedIdentityWithHttpInfo(String identityId, CreateAssociatedIdentityRequest createAssociatedIdentityRequest)`	Create an Associated Identity Create an associated `Identity` for [every owner with 25% or more ownership](/guides/onboarding/#step-3-add-associated-identities) over the merchant.
`okhttp3.Call`	`createIdentityAsync(CreateIdentityRequest createIdentityRequest, ApiCallback<Identity> _callback)`	Create an Identity (asynchronously) Create an `Identity` for your merchant or buyer.
`okhttp3.Call`	`createIdentityCall(CreateIdentityRequest createIdentityRequest, ApiCallback _callback)`	Build call for createIdentity
`Verification`	`createIdentityVerification(String identityId, CreateVerificationRequest createVerificationRequest)`	Verify an Identity Verify an `Identity`.
`okhttp3.Call`	`createIdentityVerificationAsync(String identityId, CreateVerificationRequest createVerificationRequest, ApiCallback<Verification> _callback)`	Verify an Identity (asynchronously) Verify an `Identity`.
`okhttp3.Call`	`createIdentityVerificationCall(String identityId, CreateVerificationRequest createVerificationRequest, ApiCallback _callback)`	Build call for createIdentityVerification
`ApiResponse<Verification>`	`createIdentityVerificationWithHttpInfo(String identityId, CreateVerificationRequest createVerificationRequest)`	Verify an Identity Verify an `Identity`.
`ApiResponse<Identity>`	`createIdentityWithHttpInfo(CreateIdentityRequest createIdentityRequest)`	Create an Identity Create an `Identity` for your merchant or buyer.
`Identity`	`get(String identityId)`	Fetch an Identity Retrieve the details of a previously created `Identity`.
`String`	`getCustomBaseUrl()`
`FinixClient`	`getFinixClient()`
`int`	`getHostIndex()`
`okhttp3.Call`	`getIdentityAsync(String identityId, ApiCallback<Identity> _callback)`	Fetch an Identity (asynchronously) Retrieve the details of a previously created `Identity`.
`okhttp3.Call`	`getIdentityCall(String identityId, ApiCallback _callback)`	Build call for getIdentity
`ApiResponse<Identity>`	`getIdentityWithHttpInfo(String identityId)`	Fetch an Identity Retrieve the details of a previously created `Identity`.
`FinixList`	`list(ListIdentitiesQueryParams listIdentitiesQueryParams)`	List Identities Retrieves a list of `Identities`.
`FinixList`	`listAssociatedIdentities(String identityId, ListIdentityAssociatedIdentitiesQueryParams listIdentityAssociatedIdentitiesQueryParams)`	List Associated Identities Retrieve a list of `Associated Identities` for an `Identity`.
`void`	`setCustomBaseUrl(String customBaseUrl)`
`void`	`setFinixClient(FinixClient finixClient)`
`void`	`setHostIndex(int hostIndex)`
`Identity`	`update(String identityId, UpdateIdentityRequest updateIdentityRequest)`	Update an Identity Update an existing `Identity`.
`okhttp3.Call`	`updateIdentityAsync(String identityId, UpdateIdentityRequest updateIdentityRequest, ApiCallback<Identity> _callback)`	Update an Identity (asynchronously) Update an existing `Identity`.
`okhttp3.Call`	`updateIdentityCall(String identityId, UpdateIdentityRequest updateIdentityRequest, ApiCallback _callback)`	Build call for updateIdentity
`ApiResponse<Identity>`	`updateIdentityWithHttpInfo(String identityId, UpdateIdentityRequest updateIdentityRequest)`	Update an Identity Update an existing `Identity`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IdentitiesApi
```
public IdentitiesApi()
```

IdentitiesApi

public IdentitiesApi(FinixClient finixClient)

Method Detail

getFinixClient
```
public FinixClient getFinixClient()
```

setFinixClient

public void setFinixClient(FinixClient finixClient)

getHostIndex
```
public int getHostIndex()
```

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl
```
public String getCustomBaseUrl()
```

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

createAssociatedIdentityCall

public okhttp3.Call createAssociatedIdentityCall(String identityId,
                                                 CreateAssociatedIdentityRequest createAssociatedIdentityRequest,
                                                 ApiCallback _callback)
                                          throws ApiException

Build call for createAssociatedIdentity

Parameters:

identityId - ID of `Identity` to associate object with. (required)

createAssociatedIdentityRequest - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
201	Single Identity object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

createAssociatedIdentity

public Identity createAssociatedIdentity(String identityId,
                                         CreateAssociatedIdentityRequest createAssociatedIdentityRequest)
                                  throws ApiException

Create an Associated Identity Create an associated `Identity` for [every owner with 25% or more ownership](/guides/onboarding/#step-3-add-associated-identities) over the merchant.

Parameters:

identityId - ID of `Identity` to associate object with. (required)

createAssociatedIdentityRequest - (optional)

Returns:

Identity

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
201	Single Identity object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

createAssociatedIdentityWithHttpInfo

public ApiResponse<Identity> createAssociatedIdentityWithHttpInfo(String identityId,
                                                                  CreateAssociatedIdentityRequest createAssociatedIdentityRequest)
                                                           throws ApiException

Create an Associated Identity Create an associated `Identity` for [every owner with 25% or more ownership](/guides/onboarding/#step-3-add-associated-identities) over the merchant.

Parameters:

identityId - ID of `Identity` to associate object with. (required)

createAssociatedIdentityRequest - (optional)

Returns:

ApiResponse<Identity>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
201	Single Identity object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

createAssociatedIdentityAsync

public okhttp3.Call createAssociatedIdentityAsync(String identityId,
                                                  CreateAssociatedIdentityRequest createAssociatedIdentityRequest,
                                                  ApiCallback<Identity> _callback)
                                           throws ApiException

Create an Associated Identity (asynchronously) Create an associated `Identity` for [every owner with 25% or more ownership](/guides/onboarding/#step-3-add-associated-identities) over the merchant.

Parameters:

identityId - ID of `Identity` to associate object with. (required)

createAssociatedIdentityRequest - (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
201	Single Identity object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

createIdentityCall

public okhttp3.Call createIdentityCall(CreateIdentityRequest createIdentityRequest,
                                       ApiCallback _callback)
                                throws ApiException

Build call for createIdentity

Parameters:

createIdentityRequest - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
201	Single Identity object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

create

public Identity create(CreateIdentityRequest createIdentityRequest)
                throws ApiException

Create an Identity Create an `Identity` for your merchant or buyer. All fields for a buyer's `Identity` are optional. Providing `business_type` indicates that the `Identity` is being created for a Merchant. Creating `Identities` for merchants requires they provide [KYC details](/docs/guides/getting-started/). - When creating an `Identity` for a buyer , don't pass the `business_type` field. Including a value for `business_type` configures the created `Identity` to get processed as a merchant. - When creating an `Identity` for a buyer, all fields are optional . Related Guides: [Getting Started](/docs/guides/getting-started/), [Onboarding](/docs/guides/onboarding/)

Parameters:

createIdentityRequest - (optional)

Returns:

Identity

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
201	Single Identity object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

createIdentityWithHttpInfo

public ApiResponse<Identity> createIdentityWithHttpInfo(CreateIdentityRequest createIdentityRequest)
                                                 throws ApiException

Create an Identity Create an `Identity` for your merchant or buyer. All fields for a buyer's `Identity` are optional. Providing `business_type` indicates that the `Identity` is being created for a Merchant. Creating `Identities` for merchants requires they provide [KYC details](/docs/guides/getting-started/). - When creating an `Identity` for a buyer , don't pass the `business_type` field. Including a value for `business_type` configures the created `Identity` to get processed as a merchant. - When creating an `Identity` for a buyer, all fields are optional . Related Guides: [Getting Started](/docs/guides/getting-started/), [Onboarding](/docs/guides/onboarding/)

Parameters:

createIdentityRequest - (optional)

Returns:

ApiResponse<Identity>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
201	Single Identity object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

createIdentityAsync

public okhttp3.Call createIdentityAsync(CreateIdentityRequest createIdentityRequest,
                                        ApiCallback<Identity> _callback)
                                 throws ApiException

Create an Identity (asynchronously) Create an `Identity` for your merchant or buyer. All fields for a buyer's `Identity` are optional. Providing `business_type` indicates that the `Identity` is being created for a Merchant. Creating `Identities` for merchants requires they provide [KYC details](/docs/guides/getting-started/). - When creating an `Identity` for a buyer , don't pass the `business_type` field. Including a value for `business_type` configures the created `Identity` to get processed as a merchant. - When creating an `Identity` for a buyer, all fields are optional . Related Guides: [Getting Started](/docs/guides/getting-started/), [Onboarding](/docs/guides/onboarding/)

Parameters:

createIdentityRequest - (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
201	Single Identity object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

createIdentityVerificationCall

public okhttp3.Call createIdentityVerificationCall(String identityId,
                                                   CreateVerificationRequest createVerificationRequest,
                                                   ApiCallback _callback)
                                            throws ApiException

Build call for createIdentityVerification

Parameters:

identityId - ID of `Identity` to verify. (required)

createVerificationRequest - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
201	Single Verification object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

createIdentityVerification

public Verification createIdentityVerification(String identityId,
                                               CreateVerificationRequest createVerificationRequest)
                                        throws ApiException

Verify an Identity Verify an `Identity`.

Parameters:

identityId - ID of `Identity` to verify. (required)

createVerificationRequest - (optional)

Returns:

Verification

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
201	Single Verification object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

createIdentityVerificationWithHttpInfo

public ApiResponse<Verification> createIdentityVerificationWithHttpInfo(String identityId,
                                                                        CreateVerificationRequest createVerificationRequest)
                                                                 throws ApiException

Verify an Identity Verify an `Identity`.

Parameters:

identityId - ID of `Identity` to verify. (required)

createVerificationRequest - (optional)

Returns:

ApiResponse<Verification>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
201	Single Verification object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

createIdentityVerificationAsync

public okhttp3.Call createIdentityVerificationAsync(String identityId,
                                                    CreateVerificationRequest createVerificationRequest,
                                                    ApiCallback<Verification> _callback)
                                             throws ApiException

Verify an Identity (asynchronously) Verify an `Identity`.

Parameters:

identityId - ID of `Identity` to verify. (required)

createVerificationRequest - (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
201	Single Verification object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

getIdentityCall

public okhttp3.Call getIdentityCall(String identityId,
                                    ApiCallback _callback)
                             throws ApiException

Build call for getIdentity

Parameters:

identityId - ID of the `Identity` to fetch. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Single Identity object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

get

public Identity get(String identityId)
             throws ApiException

Fetch an Identity Retrieve the details of a previously created `Identity`.

Parameters:

identityId - ID of the `Identity` to fetch. (required)

Returns:

Identity

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Single Identity object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

getIdentityWithHttpInfo

public ApiResponse<Identity> getIdentityWithHttpInfo(String identityId)
                                              throws ApiException

Fetch an Identity Retrieve the details of a previously created `Identity`.

Parameters:

identityId - ID of the `Identity` to fetch. (required)

Returns:

ApiResponse<Identity>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Single Identity object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

getIdentityAsync

public okhttp3.Call getIdentityAsync(String identityId,
                                     ApiCallback<Identity> _callback)
                              throws ApiException

Fetch an Identity (asynchronously) Retrieve the details of a previously created `Identity`.

Parameters:

identityId - ID of the `Identity` to fetch. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Single Identity object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

list

public FinixList list(ListIdentitiesQueryParams listIdentitiesQueryParams)
               throws ApiException

List Identities Retrieves a list of `Identities`.

Returns:

APIlistIdentitiesRequest

Throws:

ApiException

Http Response Details:

Status Code	Description	Response Headers
200	List of Identity objects	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

listAssociatedIdentities

public FinixList listAssociatedIdentities(String identityId,
                                          ListIdentityAssociatedIdentitiesQueryParams listIdentityAssociatedIdentitiesQueryParams)
                                   throws ApiException

List Associated Identities Retrieve a list of `Associated Identities` for an `Identity`.

Parameters:

identityId - ID of `Identity` to associate object with. (required)

Returns:

APIlistIdentityAssociatedIdentitiesRequest

Throws:

ApiException

Http Response Details:

Status Code	Description	Response Headers
200	List of Identity objects	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

updateIdentityCall

public okhttp3.Call updateIdentityCall(String identityId,
                                       UpdateIdentityRequest updateIdentityRequest,
                                       ApiCallback _callback)
                                throws ApiException

Build call for updateIdentity

Parameters:

identityId - ID of the `Identity` to fetch. (required)

updateIdentityRequest - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Single Identity object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

update

public Identity update(String identityId,
                       UpdateIdentityRequest updateIdentityRequest)
                throws ApiException

Update an Identity Update an existing `Identity`. If you are updating the `Identity` of a `Merchant` that’s already been onboarded, you need to [verify the merchant again](#operation/createMerchantVerification).

Parameters:

identityId - ID of the `Identity` to fetch. (required)

updateIdentityRequest - (optional)

Returns:

Identity

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Single Identity object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

updateIdentityWithHttpInfo

public ApiResponse<Identity> updateIdentityWithHttpInfo(String identityId,
                                                        UpdateIdentityRequest updateIdentityRequest)
                                                 throws ApiException

Update an Identity Update an existing `Identity`. If you are updating the `Identity` of a `Merchant` that’s already been onboarded, you need to [verify the merchant again](#operation/createMerchantVerification).

Parameters:

identityId - ID of the `Identity` to fetch. (required)

updateIdentityRequest - (optional)

Returns:

ApiResponse<Identity>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Single Identity object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

updateIdentityAsync

public okhttp3.Call updateIdentityAsync(String identityId,
                                        UpdateIdentityRequest updateIdentityRequest,
                                        ApiCallback<Identity> _callback)
                                 throws ApiException

Update an Identity (asynchronously) Update an existing `Identity`. If you are updating the `Identity` of a `Merchant` that’s already been onboarded, you need to [verify the merchant again](#operation/createMerchantVerification).

Parameters:

identityId - ID of the `Identity` to fetch. (required)

updateIdentityRequest - (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Single Identity object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

Modifier and Type	Class	Description
`class`	`IdentitiesApi.APIlistIdentitiesRequest`
`class`	`IdentitiesApi.APIlistIdentityAssociatedIdentitiesRequest`

Class IdentitiesApi

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IdentitiesApi

IdentitiesApi

Method Detail

getFinixClient

setFinixClient

getHostIndex

setHostIndex

getCustomBaseUrl

setCustomBaseUrl

createAssociatedIdentityCall

createAssociatedIdentity

createAssociatedIdentityWithHttpInfo

createAssociatedIdentityAsync

createIdentityCall

create

createIdentityWithHttpInfo

createIdentityAsync

createIdentityVerificationCall

createIdentityVerification

createIdentityVerificationWithHttpInfo

createIdentityVerificationAsync

getIdentityCall

get

getIdentityWithHttpInfo

getIdentityAsync

list

listAssociatedIdentities

updateIdentityCall

update

updateIdentityWithHttpInfo

updateIdentityAsync