Retrieve a contractor

GET /api/v1/contractors/{contractor}

Retrieves the details of an existing contractor. You need only supply the unique contractor identifier that was returned upon contractor creation.

Servers

• Production server: https://api.1099policy.com (Production server)

Parameters

Path parameters

• contractor (string)
  The ID of the desired contractor (e.g., cn_Ehb3bYa).

Responses

200

Returns a contractor object if a valid identifier was provided.

Body: application/json (object)

• address (object)

• company_name (string | null)
  The contractor's business name.

• created (integer(int64))

• custom_metadata (object)
  Set of key-value pairs that you can attach to the contractor object. Used for storing additional information in a structured format. Individual keys can be unset by posting an empty value to them. Pass an empty value, e.g. {}, to custom_metadata to unset all keys.

• email (string)
  The contractor's email address.

• first_name (string)
  The contractor's first name.

• id (string)

• last_name (string)
  The contractor's last name.

• middle_name (string | null)
  The contractor's middle name.

• phone (string)
  The contractor's phone number.

• withhold_premium ()
  This indicates whether the contractor is paying premium directly with their credit card (i.e., false) or if the contractor has given the platform that's integrating with 1099Policy permission to withhold the premium payment from their wages and pay the premium on the contractor's behalf (i.e., true). Defaults to false.