Page
objectPage metadata for a token-based list response.
Number of items actually returned in this response — equal to items.length. On an empty result this is 0. This is NOT a copy of the request’s page_size hint; clients holding the hint already know what they asked for.
>= 0
Example:25
Opaque token to request the next page. null when this is the last page. Pass back as the page_token query parameter to resume.
Example:eyJ2IjoxLCJrIjp7InVwZGF0ZWRBdCI6IjIwMjYtMDUtMTlUMTI6MDA6MDBaIiwiaWQiOiIwMUhYWVoifX0
CreateBankAccountRequest
objectThe type of bank account
Allowed values:SAVINGSCHECKING
Example:CHECKING
Name of the account holder
Example:Jane Doe
Bank account number (4-17 characters)
>= 4 characters<= 17 characters
Example:1234567890
Bank routing number (exactly 9 digits)
>= 9 characters<= 9 characters
Example:021000021
Name of the bank
Example:Chase Bank
Optional nickname for the bank account
Example:Main
Whether this should become the owner’s primary bank account. Setting true demotes any existing primary for the same owner. Defaults to false (the owner’s first bank account always becomes primary regardless of this value). null is treated the same as omitted.
Default:false
PolicyType
stringThe type of insurance policy
Allowed values:CORPORATIONINDIVIDUALJOINT
InsurancePolicyV2
objectUnique identifier for the insurance policy.
The type of insurance policy
Allowed values:CORPORATIONINDIVIDUALJOINT
Example:INDIVIDUAL
Name of the insurance carrier.
Maximum coverage limit for the policy.
Date the insurance policy became effective (YYYY-MM-DD).
Date the insurance policy expires (YYYY-MM-DD).
Policy number assigned by the carrier.
Certificate number for the policy.
Whether a certificate file has been uploaded for this policy.
Presigned download URL for the certificate file. Present only when hasFile is true. Expires 10 minutes after the response is generated.
RFC3339 UTC timestamp when the record was created.
RFC3339 UTC timestamp when the record was last updated.
UpdateInsurancePolicyRequest
objectThe type of insurance policy
Allowed values:CORPORATIONINDIVIDUALJOINT
Example:INDIVIDUAL
Name of the insurance carrier.
Example:Acme Insurance Co.
Maximum coverage limit for the policy.
>= 1<= 10000000
Example:1000000
Date the insurance policy becomes effective (YYYY-MM-DD).
Example:2024-01-01
Date the insurance policy expires (YYYY-MM-DD).
Example:2025-01-01
Policy number assigned by the carrier.
Example:POL-001
Certificate number for the policy.
Example:CERT-001