Package markets.alpaca.client.openapi.broker.api

Class KycApi

java.lang.Object
markets.alpaca.client.openapi.broker.api.KycApi
public class KycApi extends Object
Generated client for KycApi operations.

This class is generated from the configured OpenAPI spec. Operation method Javadocs include OAS summaries, descriptions, parameters, return types, response details, and external documentation links when present in the spec.

Operations

  • getV1AccountsAccountIdCip: Retrieve CIP information
  • getV1AccountsAccountIdOnfidoSdkTokens: Retrieve an Onfido SDK Token
  • patchV1AccountsAccountIdOnfidoSdk: Update the Onfido SDK Outcome
  • postV1AccountsAccountIdCip: Upload CIP information

  • Constructor Details

    • KycApi

      public KycApi()

    • KycApi

      public KycApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • getHostIndex

      public int getHostIndex()

    • setHostIndex

      public void setHostIndex(int hostIndex)

    • getCustomBaseUrl

      public String getCustomBaseUrl()

    • setCustomBaseUrl

      public void setCustomBaseUrl(String customBaseUrl)

    • getV1AccountsAccountIdCipCall

      public okhttp3.Call getV1AccountsAccountIdCipCall(@Nonnull String accountId, ApiCallback _callback) throws ApiException
      Build call for getV1AccountsAccountIdCip
      Parameters:
      accountId - (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -

    • getV1AccountsAccountIdCip

      public CIPInfo getV1AccountsAccountIdCip(@Nonnull String accountId) throws ApiException
      Retrieve CIP information You can retrieve the CIP information you've submitted for a given account.
      Parameters:
      accountId - (required)
      Returns:
      CIPInfo
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -

    • getV1AccountsAccountIdCipWithHttpInfo

      public ApiResponse<CIPInfo> getV1AccountsAccountIdCipWithHttpInfo(@Nonnull String accountId) throws ApiException
      Retrieve CIP information You can retrieve the CIP information you've submitted for a given account.
      Parameters:
      accountId - (required)
      Returns:
      ApiResponse<CIPInfo>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -

    • getV1AccountsAccountIdCipAsync

      public okhttp3.Call getV1AccountsAccountIdCipAsync(@Nonnull String accountId, ApiCallback<CIPInfo> _callback) throws ApiException
      Retrieve CIP information (asynchronously) You can retrieve the CIP information you've submitted for a given account.
      Parameters:
      accountId - (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:
      Response Details
      Status Code Description Response Headers
      200 OK -

    • getV1AccountsAccountIdOnfidoSdkTokensCall

      public okhttp3.Call getV1AccountsAccountIdOnfidoSdkTokensCall(@Nonnull UUID accountId, @Nullable String referrer, @Nullable String platform, ApiCallback _callback) throws ApiException
      Build call for getV1AccountsAccountIdOnfidoSdkTokens
      Parameters:
      accountId - The account ID (required)
      referrer - The referrer URL of your web app or the application ID of your mobile app. If not passed in, will default to the * wildcard (optional)
      platform - Required if referrer provided. Enum values are either mobile or web (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -
      422 Onfido applicant not yet created for account. If you haven't already contacted Alapca to enable Onfido, please do so. -

    • getV1AccountsAccountIdOnfidoSdkTokens

      public GetV1AccountsAccountIdOnfidoSdkTokens200Response getV1AccountsAccountIdOnfidoSdkTokens(@Nonnull UUID accountId, @Nullable String referrer, @Nullable String platform) throws ApiException
      Retrieve an Onfido SDK Token Get an SDK token to activate the Onfido SDK flow within your app. You will have to keep track of the SDK token so you can pass it back when you upload the SDK outcome. We recommend storing the token in memory rather than persistent storage to reduce any unnecessary overhead in your app.
      Parameters:
      accountId - The account ID (required)
      referrer - The referrer URL of your web app or the application ID of your mobile app. If not passed in, will default to the * wildcard (optional)
      platform - Required if referrer provided. Enum values are either mobile or web (optional)
      Returns:
      GetV1AccountsAccountIdOnfidoSdkTokens200Response
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -
      422 Onfido applicant not yet created for account. If you haven't already contacted Alapca to enable Onfido, please do so. -

    • getV1AccountsAccountIdOnfidoSdkTokensWithHttpInfo

      public ApiResponse<GetV1AccountsAccountIdOnfidoSdkTokens200Response> getV1AccountsAccountIdOnfidoSdkTokensWithHttpInfo(@Nonnull UUID accountId, @Nullable String referrer, @Nullable String platform) throws ApiException
      Retrieve an Onfido SDK Token Get an SDK token to activate the Onfido SDK flow within your app. You will have to keep track of the SDK token so you can pass it back when you upload the SDK outcome. We recommend storing the token in memory rather than persistent storage to reduce any unnecessary overhead in your app.
      Parameters:
      accountId - The account ID (required)
      referrer - The referrer URL of your web app or the application ID of your mobile app. If not passed in, will default to the * wildcard (optional)
      platform - Required if referrer provided. Enum values are either mobile or web (optional)
      Returns:
      ApiResponse<GetV1AccountsAccountIdOnfidoSdkTokens200Response>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -
      422 Onfido applicant not yet created for account. If you haven't already contacted Alapca to enable Onfido, please do so. -

    • getV1AccountsAccountIdOnfidoSdkTokensAsync

      public okhttp3.Call getV1AccountsAccountIdOnfidoSdkTokensAsync(@Nonnull UUID accountId, @Nullable String referrer, @Nullable String platform, ApiCallback<GetV1AccountsAccountIdOnfidoSdkTokens200Response> _callback) throws ApiException
      Retrieve an Onfido SDK Token (asynchronously) Get an SDK token to activate the Onfido SDK flow within your app. You will have to keep track of the SDK token so you can pass it back when you upload the SDK outcome. We recommend storing the token in memory rather than persistent storage to reduce any unnecessary overhead in your app.
      Parameters:
      accountId - The account ID (required)
      referrer - The referrer URL of your web app or the application ID of your mobile app. If not passed in, will default to the * wildcard (optional)
      platform - Required if referrer provided. Enum values are either mobile or web (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:
      Response Details
      Status Code Description Response Headers
      200 OK -
      422 Onfido applicant not yet created for account. If you haven't already contacted Alapca to enable Onfido, please do so. -

    • patchV1AccountsAccountIdOnfidoSdkCall

      public okhttp3.Call patchV1AccountsAccountIdOnfidoSdkCall(@Nonnull String accountId, @Nullable PatchV1AccountsAccountIdOnfidoSdkRequest patchV1AccountsAccountIdOnfidoSdkRequest, ApiCallback _callback) throws ApiException
      Build call for patchV1AccountsAccountIdOnfidoSdk
      Parameters:
      accountId - (required)
      patchV1AccountsAccountIdOnfidoSdkRequest - (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -
      404 Account Not Found -
      422 Invalid input value for outcome. -

    • patchV1AccountsAccountIdOnfidoSdk

      public void patchV1AccountsAccountIdOnfidoSdk(@Nonnull String accountId, @Nullable PatchV1AccountsAccountIdOnfidoSdkRequest patchV1AccountsAccountIdOnfidoSdkRequest) throws ApiException
      Update the Onfido SDK Outcome This request allows you to send Alpaca the result of the Onfido SDK flow in your app. A notification of a successful outcome is required for Alpaca to continue the KYC process.
      Parameters:
      accountId - (required)
      patchV1AccountsAccountIdOnfidoSdkRequest - (optional)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -
      404 Account Not Found -
      422 Invalid input value for outcome. -

    • patchV1AccountsAccountIdOnfidoSdkWithHttpInfo

      public ApiResponse<Void> patchV1AccountsAccountIdOnfidoSdkWithHttpInfo(@Nonnull String accountId, @Nullable PatchV1AccountsAccountIdOnfidoSdkRequest patchV1AccountsAccountIdOnfidoSdkRequest) throws ApiException
      Update the Onfido SDK Outcome This request allows you to send Alpaca the result of the Onfido SDK flow in your app. A notification of a successful outcome is required for Alpaca to continue the KYC process.
      Parameters:
      accountId - (required)
      patchV1AccountsAccountIdOnfidoSdkRequest - (optional)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -
      404 Account Not Found -
      422 Invalid input value for outcome. -

    • patchV1AccountsAccountIdOnfidoSdkAsync

      public okhttp3.Call patchV1AccountsAccountIdOnfidoSdkAsync(@Nonnull String accountId, @Nullable PatchV1AccountsAccountIdOnfidoSdkRequest patchV1AccountsAccountIdOnfidoSdkRequest, ApiCallback<Void> _callback) throws ApiException
      Update the Onfido SDK Outcome (asynchronously) This request allows you to send Alpaca the result of the Onfido SDK flow in your app. A notification of a successful outcome is required for Alpaca to continue the KYC process.
      Parameters:
      accountId - (required)
      patchV1AccountsAccountIdOnfidoSdkRequest - (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:
      Response Details
      Status Code Description Response Headers
      200 OK -
      404 Account Not Found -
      422 Invalid input value for outcome. -

    • postV1AccountsAccountIdCipCall

      public okhttp3.Call postV1AccountsAccountIdCipCall(@Nonnull String accountId, @Nullable CIPInfo ciPInfo, ApiCallback _callback) throws ApiException
      Build call for postV1AccountsAccountIdCip
      Parameters:
      accountId - (required)
      ciPInfo - (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -

    • postV1AccountsAccountIdCip

      public void postV1AccountsAccountIdCip(@Nonnull String accountId, @Nullable CIPInfo ciPInfo) throws ApiException
      Upload CIP information The customer identification program (CIP) API allows you to submit the CIP results received from your KYC provider. The minimum requirements to open an individual financial account are delimited and you must verify the true identity of the account holder at account opening: Name Date of birth Address Identification number (for a U.S. citizen, a taxpayer identification number)
      Parameters:
      accountId - (required)
      ciPInfo - (optional)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -

    • postV1AccountsAccountIdCipWithHttpInfo

      public ApiResponse<Void> postV1AccountsAccountIdCipWithHttpInfo(@Nonnull String accountId, @Nullable CIPInfo ciPInfo) throws ApiException
      Upload CIP information The customer identification program (CIP) API allows you to submit the CIP results received from your KYC provider. The minimum requirements to open an individual financial account are delimited and you must verify the true identity of the account holder at account opening: Name Date of birth Address Identification number (for a U.S. citizen, a taxpayer identification number)
      Parameters:
      accountId - (required)
      ciPInfo - (optional)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 OK -

    • postV1AccountsAccountIdCipAsync

      public okhttp3.Call postV1AccountsAccountIdCipAsync(@Nonnull String accountId, @Nullable CIPInfo ciPInfo, ApiCallback<Void> _callback) throws ApiException
      Upload CIP information (asynchronously) The customer identification program (CIP) API allows you to submit the CIP results received from your KYC provider. The minimum requirements to open an individual financial account are delimited and you must verify the true identity of the account holder at account opening: Name Date of birth Address Identification number (for a U.S. citizen, a taxpayer identification number)
      Parameters:
      accountId - (required)
      ciPInfo - (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:
      Response Details
      Status Code Description Response Headers
      200 OK -