Package io.moov.sdk

Class Underwriting

java.lang.Object

io.moov.sdk.Underwriting

All Implemented Interfaces:

SDKMethodInterfaces.MethodCallGetUnderwriting, SDKMethodInterfaces.MethodCallUpsertUnderwriting

public class Underwriting
extends java.lang.Object
implements SDKMethodInterfaces.MethodCallGetUnderwriting, SDKMethodInterfaces.MethodCallUpsertUnderwriting

Method Summary

Modifier and Type	Method	Description
GetUnderwritingRequestBuilder	get()	Retrieve underwriting associated with a given Moov account.
GetUnderwritingResponse	get(java.lang.String accountID)	Retrieve underwriting associated with a given Moov account.
GetUnderwritingResponse	get(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String accountID)	Retrieve underwriting associated with a given Moov account.
UpsertUnderwritingRequestBuilder	upsert()	Create or update the account's underwriting.
UpsertUnderwritingResponse	upsert(java.lang.String accountID, UpdateUnderwriting updateUnderwriting)	Create or update the account's underwriting.
UpsertUnderwritingResponse	upsert(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String accountID, UpdateUnderwriting updateUnderwriting)	Create or update the account's underwriting.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

get

public GetUnderwritingRequestBuilder get()

Retrieve underwriting associated with a given Moov account.

Read our [underwriting guide](https://docs.moov.io/guides/accounts/requirements/underwriting/) to learn more.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/profile.read` scope.

Returns:

The call builder

get

public GetUnderwritingResponse get(java.lang.String accountID)
                            throws java.lang.Exception

Retrieve underwriting associated with a given Moov account.

Read our [underwriting guide](https://docs.moov.io/guides/accounts/requirements/underwriting/) to learn more.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/profile.read` scope.

Parameters:

accountID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

get

public GetUnderwritingResponse get(java.util.Optional<java.lang.String> xMoovVersion,
                                   java.lang.String accountID)
                            throws java.lang.Exception

Retrieve underwriting associated with a given Moov account.

Read our [underwriting guide](https://docs.moov.io/guides/accounts/requirements/underwriting/) to learn more.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/profile.read` scope.

Specified by:

get in interface SDKMethodInterfaces.MethodCallGetUnderwriting

Parameters:

xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

accountID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

upsert

public UpsertUnderwritingRequestBuilder upsert()

Create or update the account's underwriting.

Read our [underwriting guide](https://docs.moov.io/guides/accounts/requirements/underwriting/) to learn more.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/profile.write` scope.

Returns:

The call builder

upsert

public UpsertUnderwritingResponse upsert(java.lang.String accountID,
                                         UpdateUnderwriting updateUnderwriting)
                                  throws java.lang.Exception

Create or update the account's underwriting.

Read our [underwriting guide](https://docs.moov.io/guides/accounts/requirements/underwriting/) to learn more.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/profile.write` scope.

Parameters:

accountID -

updateUnderwriting -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

upsert

public UpsertUnderwritingResponse upsert(java.util.Optional<java.lang.String> xMoovVersion,
                                         java.lang.String accountID,
                                         UpdateUnderwriting updateUnderwriting)
                                  throws java.lang.Exception

Create or update the account's underwriting.

Read our [underwriting guide](https://docs.moov.io/guides/accounts/requirements/underwriting/) to learn more.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/profile.write` scope.

Specified by:

upsert in interface SDKMethodInterfaces.MethodCallUpsertUnderwriting

Parameters:

xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

accountID -

updateUnderwriting -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails