JUjustifi
Bind Insurance

Bind an Insurance Policy

Used to bind an insurance policy with a JustiFi insurance partner

post/insurance/bind

Request

Headers

Authorizationstring required

the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)

Request body

payment_method_idstring uuid required

Payment method to charge for insurance policy

amountnumber required

amount to charge in cents

currency'usd' | 'cad'
partner_quote_idstring required

quote id provided by partner provider

partner_name'vertical_insure' required

partner insurance provider

metadataobject

any useful information you'd like to store alongside this record

Example request

{
  "payment_method_id": "pm_123",
  "amount": 10000,
  "currency": "usd",
  "partner_quote_id": "ins-test-123",
  "partner_name": "vertical_insure",
  "metadata": {}
}

Response

Insurance Policy was bound successfully

idstring uuid

the object id, also found in the data object

typestring

the object type, or array of objects

page_infounknown

Example response

{
  "id": "ins_xyz",
  "type": "insurance_policy",
  "data": {
    "id": "ins_xyz",
    "account_id": "acc_xyz",
    "amount": 10000,
    "currency": "usd",
    "partner_name": "vertical_insure",
    "partner_quote_id": "test-123",
    "metadata": {},
    "created_at": "2021-01-01T12:00:00Z",
    "updated_at": "2021-01-01T12:00:00Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.