Documents

Information about a document - for example, completed forms, files uploaded by caseworkers, or reference forms. Each kind of document has a unique slug - for a complete list of slugs and how they map to the documents available in Binti, please contact your account manager.

• id* (string) - The primary key for the record.

• type* (string) - The JSON:API type specifier.

  Allowed values

  • documents

• attributes* (object) - Primary record attributes.

  • owner-agency-slug* (string) - The slug for the agency which owns this data

  • category* (string) - Available category options.

    Allowed values

    • signed_application
    • signed_reference
    • other_uploaded_by_admin
    • psycho_social
    • collated_document
    • other_cbo_uploaded_by_admin
    • bintisign_doc_template
    • signed_document
    • child_photo
    • home_study
    • raw_data_validator_file
    • validated_data_validator_file
    • raw_rate_table_file
    • public_upload
    • email_campaign_file
    • pulled_report_partial_csv
    • uploaded_record

  • created-at* (string) - Date time that the Document was created.

  • name* (string) - The name of the document.

  • file-content-type* (string) - The MIME content type of the document.

  • file-data (string) - base64-encoded file data.

  • file-filename* (string) - The file's filename.

  • file-size* (number) - The file's size, in bytes.

  • slug* (string) - The identifier describing the type of document.

  • license-external-identifier* (string) - If this file is associated with an Application, the license external identifier for that Application.

• relationships (object) - Related objects. For each relationship, you can find detailed information about the object by issuing another API call to look it up by ID, or for certain endpoints, you will find details in the "included" section.

  • signatures (object) - A relationship with multiple entries.
    • data* (array) - Array of entries.

      • id* (string) - The ID of the other object.

      • type* (string) - Always required-signatures

        Allowed values

        • required-signatures

• links* (object) - Convenience URLs for the current record.

  • self (string) - A link to the attachment