Required Signatures

A required signature is a record of the types of signatures required for forms. This contains information about both compeleted signatures and incomplete signatures. Signer information is only provided post signature but there will be slots for the remaining roles who have not signed yet.

• id* (string) - The primary key for the record.
• type* (string) - The JSON:API type specifier.
• attributes* (object) - Primary record attributes.

  • created-at* (string) - Datetime Required Signature was created.

  • updated-at* (string) - Datetime Required Signature was last updated.

  • role* (string) - Role of user signing form.

    Allowed values

    • co_applicant
    • applicant
    • reference_user
    • caseworker
    • other_adult_in_home
    • supervisor

  • order* (string) - Order in which this signature is collected.

  • compelete-at* (string) - Datetime when signature was complete.