AccountHolderRetrieveDocumentParams 0.129.0 API

All Implemented Interfaces:

com.lithic.api.core.Params
```
public final class AccountHolderRetrieveDocumentParams
 implements Params
                    
```
Check the status of an account holder document upload, or retrieve the upload URLs to process your image uploads.
Note that this is not equivalent to checking the status of the KYC evaluation overall (a document may be successfully uploaded but not be sufficient for KYC to pass).
In the event your upload URLs have expired, calling this endpoint will refresh them. Similarly, in the event a document upload has failed, you can use this endpoint to get a new upload URL for the failed image upload.
When a new account holder document upload is generated for a failed attempt, the response will show an additional entry in the required_document_uploads array in a PENDING state for the corresponding image_type.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`AccountHolderRetrieveDocumentParams.Builder`	A builder for AccountHolderRetrieveDocumentParams.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`accountHolderToken()`
`final Optional<String>`	`documentToken()`
`final Headers`	`_additionalHeaders()`	Additional headers to send with the request.
`final QueryParams`	`_additionalQueryParams()`	Additional query param to send with the request.
`final AccountHolderRetrieveDocumentParams.Builder`	`toBuilder()`
`final String`	`_pathParam(Integer index)`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static AccountHolderRetrieveDocumentParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of AccountHolderRetrieveDocumentParams.

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

- Constructor Detail
- Method Detail
  - accountHolderToken
```
 final String accountHolderToken()
```
  - documentToken
```
 final Optional<String> documentToken()
```
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
    Additional headers to send with the request.
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
    Additional query param to send with the request.
  - toBuilder
```
 final AccountHolderRetrieveDocumentParams.Builder toBuilder()
```
  - _pathParam
```
 final String _pathParam(Integer index)
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static AccountHolderRetrieveDocumentParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of AccountHolderRetrieveDocumentParams.
    The following fields are required:
    .accountHolderToken()