Get the screening report

`Any` contains an arbitrary serialized protocol buffer message along with a
URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form
of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++.

    Foo foo = ...;
    Any any;
    any.PackFrom(foo);
    ...
    if (any.UnpackTo(&foo)) {
      ...
    }

Example 2: Pack and unpack a message in Java.

    Foo foo = ...;
    Any any = Any.pack(foo);
    ...
    if (any.is(Foo.class)) {
      foo = any.unpack(Foo.class);
    }
    // or ...
    if (any.isSameTypeAs(Foo.getDefaultInstance())) {
      foo = any.unpack(Foo.getDefaultInstance());
    }

 Example 3: Pack and unpack a message in Python.

    foo = Foo(...)
    any = Any()
    any.Pack(foo)
    ...
    if any.Is(Foo.DESCRIPTOR):
      any.Unpack(foo)
      ...

 Example 4: Pack and unpack a message in Go

     foo := &pb.Foo{...}
     any, err := anypb.New(foo)
     if err != nil {
       ...
     }
     ...
     foo := &pb.Foo{}
     if err := any.UnmarshalTo(foo); err != nil {
       ...
     }

The pack methods provided by protobuf library will by default use
'type.googleapis.com/full.type.name' as the type URL and the unpack
methods only use the fully qualified type name after the last '/'
in the type URL, for example "foo.bar.com/x/y.z" will yield type
name "y.z".

JSON
====
The JSON representation of an `Any` value uses the regular
representation of the deserialized, embedded message, with an
additional field `@type` which contains the type URL. Example:

    package google.profile;
    message Person {
      string first_name = 1;
      string last_name = 2;
    }

    {
      "@type": "type.googleapis.com/google.profile.Person",
      "firstName": <string>,
      "lastName": <string>
    }

If the embedded message type is well-known and has a custom JSON
representation, that representation will be embedded adding a field
`value` which holds the custom JSON in addition to the `@type`
field. Example (for message [google.protobuf.Duration][]):

    {
      "@type": "type.googleapis.com/google.protobuf.Duration",
      "value": "1.212s"
    }

A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
`path/google.protobuf.Duration`). The name should be in a canonical form
(e.g., leading "." is not accepted).

In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme `http`, `https`, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:

* If no scheme is provided, `https` is assumed.
* An HTTP GET on the URL must yield a [google.protobuf.Type][]
  value in binary format, or produce an error.
* Applications are allowed to cache lookup results based on the
  URL, or have them precompiled into a binary to avoid any
  lookup. Therefore, binary compatibility needs to be preserved
  on changes to types. (Use versioned type names to manage
  breaking changes.)

Note: this functionality is not currently available in the official
protobuf release, and it is not used for type URLs beginning with
type.googleapis.com. As of May 2023, there are no widely used type server
implementations and no plans to implement one.

Schemes other than `http`, `https` (or the empty scheme) might be
used with implementation specific semantics.

ApiTokenAuth

Cove Documentation

Cove is an all-in-one screening and verification platform which helps anyone that is renting anything out to anyone else make better decisions. Think of it like a credit report on steroids.  

Introduction

Welcome to the Cove API Quickstart! This guide provides a detailed walkthrough of how to use the API, from setting up your account to conducting applicant screenings.

Quickstart

Learn how to create and use custom screening flows with the Cove API.

Screening Flows

Learn about the providers available for each verification step in Cove.

Providers

Learn how to configure options at both node and flow levels.

Options

Learn how to create and use control flows with the Cove API.

Control Flow

A comprehensive tenant screening flow that includes identity verification, employment verification, credit assessment, and rental history verification to evaluate tenant eligibility.

Tenant Screening Flow

A comprehensive mortgage application flow that includes identity verification, financial assessment, employment verification, and background checks to evaluate mortgage eligibility.

Mortgage Application Flow

The ID verification step allows for automated verification of government-issued identification documents. It supports features such as selfie matching, liveness detection, and document expiration validation.

ID Verification

The personal information step collects and validates essential applicant details required for mortgage applications.

Personal Information

The employment verification step validates an individual's current employment status and income information through payroll providers.

Employment

The bank connect step verifies bank account information, analyzes transactions, and validates account ownership.

Bank Connect

The residence history step verifies an individual's residential addresses for the past three years through manual document verification by an advisor.

Residence History

The assets verification step validates an individual's financial assets and property ownership to determine net worth and verify down payment sources.

Assets

Credit report is a flow option that retrieves and analyzes an individual's credit history from major credit bureaus.

API Reference

Flow

Step

Property

Screening

Rent Reporting

ScreeningV2

Get the screening report

Authorizations

Path Parameters

Response