Constructor Detail

Method Detail

• id

   final String id()

  A stable Finch id for the document.

• individualId

   final Optional<String> individualId()

  The ID of the individual associated with the document. This will be null for employer-level documents.

• type

   final DocumentResponse.Type type()

  The type of document.

• url

   final String url()

  A URL to access the document. Format: https://api.tryfinch.com/employer/documents/:document_id.

• year

   final Double year()

  The year the document applies to, if available.

• _id

   final JsonField<String> _id()

  Returns the raw JSON value of id.

  Unlike id, this method doesn't throw if the JSON field has an unexpected type.

• _individualId

   final JsonField<String> _individualId()

  Returns the raw JSON value of individualId.

  Unlike individualId, this method doesn't throw if the JSON field has an unexpected type.

• _type

   final JsonField<DocumentResponse.Type> _type()

  Returns the raw JSON value of type.

  Unlike type, this method doesn't throw if the JSON field has an unexpected type.

• _url

   final JsonField<String> _url()

  Returns the raw JSON value of url.

  Unlike url, this method doesn't throw if the JSON field has an unexpected type.

• _year

   final JsonField<Double> _year()

  Returns the raw JSON value of year.

  Unlike year, this method doesn't throw if the JSON field has an unexpected type.

• _additionalProperties

   final Map<String, JsonValue> _additionalProperties()

• toBuilder

   final DocumentResponse.Builder toBuilder()

• validate

   final DocumentResponse validate()

  Validates that the types of all values in this object match their expected types recursively.

  This method is not forwards compatible with new types from the API for existing fields.

• isValid

   final Boolean isValid()

• equals

   Boolean equals(Object other)

• hashCode

   Integer hashCode()

• toString

   String toString()

• builder

   final static DocumentResponse.Builder builder()

  Returns a mutable builder for constructing an instance of DocumentResponse.

  The following fields are required:

  .id()
  .individualId()
  .type()
  .url()
  .year()