Letter from the Payor (Alimony or Child Support)

This is a document typically directed to the recipient (payee), providing information about financial arrangements and details pertaining to support payments. It is often necessary for legal or administrative purposes.

To use the Upload PDF endpoint for this document, you must use letter_from_the_payor in the form_type parameter.

Field descriptions

The following fields are available on this document type:

JSON AttributeData TypeDescription
letter_from_the_payor-Part1-General:dateOfTheLetterDateDate Of The Letter
letter_from_the_payor-Part1-General:payorNameTextPayor Name
letter_from_the_payor-Part1-General:payorAddress:addressLine1TextPayor Address
letter_from_the_payor-Part1-General:payorAddress:addressLine2TextPayor Address
letter_from_the_payor-Part1-General:payorAddress:cityTextPayor Address
letter_from_the_payor-Part1-General:payorAddress:stateStatePayor Address
letter_from_the_payor-Part1-General:payorAddress:zipZIP CodePayor Address
letter_from_the_payor-Part1-General:borrowerNameTextBorrower Name
letter_from_the_payor-Part1-General:borrowerAddress:addressLine1TextBorrower Address
letter_from_the_payor-Part1-General:borrowerAddress:addressLine2TextBorrower Address
letter_from_the_payor-Part1-General:borrowerAddress:cityTextBorrower Address
letter_from_the_payor-Part1-General:borrowerAddress:stateStateBorrower Address
letter_from_the_payor-Part1-General:borrowerAddress:zipZIP CodeBorrower Address
letter_from_the_payor-Part2-AlimonyOrChildSupport:nameOfPerson/ChildrenTextName Of Person/Children
letter_from_the_payor-Part2-AlimonyOrChildSupport:amountOfPaymentsMoneyAmount Of Payments
letter_from_the_payor-Part2-AlimonyOrChildSupport:frequencyOfPaymentsWEEKLY PAYMENTS, MONTHLY PAYMENTS, SEMI-MONTHLY PAYMENTS, OTHERFrequency Of Payments
letter_from_the_payor-Part2-AlimonyOrChildSupport:frequencyOfPayments-OtherDescriptionTextFrequency Of Payments - Other Description
letter_from_the_payor-Part2-AlimonyOrChildSupport:durationOfPaymentsTextDuration Of Payments
letter_from_the_payor-Part2-AlimonyOrChildSupport:natureOfPaymentsTextNature Of Payments

Sample document

Sample JSON result

{
  "pk": 39003158,
  "uuid": "80b9189e-86db-4881-9986-7eb730b94260",
  "name": "API - Q2 All Capture forms",
  "created": "2023-09-08T18:29:49Z",
  "created_ts": "2023-09-08T18:29:48Z",
  "verified_pages_count": 89,
  "book_status": "ACTIVE",
  "id": 39003158,
  "forms": [
    {
      "pk": 49666313,
      "uuid": "0b0adf02-4879-4be5-bf18-dd981afc6880",
      "uploaded_doc_pk": 59900241,
      "form_type": "LETTER_FROM_THE_PAYOR",
      "raw_fields": {
        "letter_from_the_payor-Part1-General:payorName": {
          "value": "JOSEPH SAMPLE",
          "is_empty": false,
          "alias_used": null,
          "source_filename": "API - LETTER FROM THE PAYOR.pdf",
          "confidence": 1.0
        },
        "letter_from_the_payor-Part1-General:borrowerName": {
          "value": "ARDEN EXAMPLE",
          "is_empty": false,
          "alias_used": null,
          "source_filename": "API - LETTER FROM THE PAYOR.pdf",
          "confidence": 1.0
        },
        "letter_from_the_payor-Part1-General:dateOfTheLetter": {
          "value": "10/01/2022",
          "is_empty": false,
          "alias_used": null,
          "source_filename": "API - LETTER FROM THE PAYOR.pdf",
          "confidence": 1.0
        },
        "letter_from_the_payor-Part1-General:payorAddress:zip": {
          "value": "12345",
          "is_empty": false,
          "alias_used": null,
          "source_filename": "API - LETTER FROM THE PAYOR.pdf",
          "confidence": 1.0
        },
        "letter_from_the_payor-Part1-General:payorAddress:city": {
          "value": "ANY CITY",
          "is_empty": false,
          "alias_used": null,
          "source_filename": "API - LETTER FROM THE PAYOR.pdf",
          "confidence": 1.0
        },
        "letter_from_the_payor-Part1-General:payorAddress:state": {
          "value": "NY",
          "is_empty": false,
          "alias_used": null,
          "source_filename": "API - LETTER FROM THE PAYOR.pdf",
          "confidence": 1.0
        },
        "letter_from_the_payor-Part1-General:borrowerAddress:zip": {
          "value": "",
          "is_empty": true,
          "alias_used": null,
          "source_filename": "API - LETTER FROM THE PAYOR.pdf",
          "confidence": 1.0
        },
        "letter_from_the_payor-Part1-General:borrowerAddress:city": {
          "value": "",
          "is_empty": true,
          "alias_used": null,
          "source_filename": "API - LETTER FROM THE PAYOR.pdf",
          "confidence": 1.0
        },
        "letter_from_the_payor-Part1-General:borrowerAddress:state": {
          "value": "",
          "is_empty": true,
          "alias_used": null,
          "source_filename": "API - LETTER FROM THE PAYOR.pdf",
          "confidence": 1.0
        },
        "letter_from_the_payor-Part1-General:payorAddress:addressLine1": {
          "value": "PO BOX 5432",
          "is_empty": false,
          "alias_used": null,
          "source_filename": "API - LETTER FROM THE PAYOR.pdf",
          "confidence": 1.0
        },
        "letter_from_the_payor-Part1-General:payorAddress:addressLine2": {
          "value": "",
          "is_empty": true,
          "alias_used": null,
          "source_filename": "API - LETTER FROM THE PAYOR.pdf",
          "confidence": 1.0
        },
        "letter_from_the_payor-Part1-General:borrowerAddress:addressLine1": {
          "value": "",
          "is_empty": true,
          "alias_used": null,
          "source_filename": "API - LETTER FROM THE PAYOR.pdf",
          "confidence": 1.0
        },
        "letter_from_the_payor-Part1-General:borrowerAddress:addressLine2": {
          "value": "",
          "is_empty": true,
          "alias_used": null,
          "source_filename": "API - LETTER FROM THE PAYOR.pdf",
          "confidence": 1.0
        },
        "letter_from_the_payor-Part2-AlimonyOrChildSupport:amountOfPayments": {
          "value": "1000.00",
          "is_empty": false,
          "alias_used": null,
          "source_filename": "API - LETTER FROM THE PAYOR.pdf",
          "confidence": 1.0
        },
        "letter_from_the_payor-Part2-AlimonyOrChildSupport:natureOfPayments": {
          "value": "",
          "is_empty": true,
          "alias_used": null,
          "source_filename": "API - LETTER FROM THE PAYOR.pdf",
          "confidence": 1.0
        },
        "letter_from_the_payor-Part2-AlimonyOrChildSupport:durationOfPayments": {
          "value": "",
          "is_empty": true,
          "alias_used": null,
          "source_filename": "API - LETTER FROM THE PAYOR.pdf",
          "confidence": 1.0
        },
        "letter_from_the_payor-Part2-AlimonyOrChildSupport:frequencyOfPayments": {
          "value": "MONTHLY PAYMENTS",
          "is_empty": false,
          "alias_used": null,
          "source_filename": "API - LETTER FROM THE PAYOR.pdf",
          "confidence": 1.0
        },
        "letter_from_the_payor-Part2-AlimonyOrChildSupport:nameOfPerson/Children": {
          "value": "AMISA",
          "is_empty": false,
          "alias_used": null,
          "source_filename": "API - LETTER FROM THE PAYOR.pdf",
          "confidence": 1.0
        },
        "letter_from_the_payor-Part2-AlimonyOrChildSupport:frequencyOfPayments-OtherDescription": {
          "value": "",
          "is_empty": true,
          "alias_used": null,
          "source_filename": "API - LETTER FROM THE PAYOR.pdf",
          "confidence": 1.0
        }
      },
      "form_config_pk": 253269,
      "tables": [],
      "attribute_data": null
    }
  ],
  "book_is_complete": true
}