/njclerk/documents

POST /api/njclerk/documents

Price: 1 credit

Get a recorded New Jersey land-record document by its id: the document type, recording date, book and page, instrument number, town and legal description, the grantor/borrower and grantee/lender parties with their role labels, the consideration (a deed sale price; mortgages carry none), deed and stamp taxes, MERS code, the return name and address, the e-recording submitter contact, and linked documents (a mortgage's assignments and discharge)

How to use it

The document id is the id returned by njclerk/documents/search. On a mortgage (MTG, MORT) reverse_parties is the lender and direct_parties the borrower; on a deed (DEED) direct_parties is the seller and reverse_parties the buyer; the role labels say which. consideration is the deed sale price and is absent on mortgages — the loan amount is not in the public index. linked_documents point to a mortgage's assignments and discharge.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• document_id string required — Internal document id from a njclerk/documents/search row (examples: "273209", "484282"; minLength: 1)
• county string — New Jersey county the document id belongs to (default: "salem"; examples: "salem")

Response

• @type string (default: "NjclerkDocument")
• id string required
• doc_type string nullable
• doc_group string nullable
• status string nullable
• recording_date integer nullable
• executed_at integer nullable
• entered_at integer nullable
• book_type string nullable
• book string nullable
• page string nullable
• instrument_number string nullable
• document_pages integer nullable
• town string nullable
• legal_description string nullable
• lot string nullable
• block string nullable
• direct_label string nullable
• reverse_label string nullable
• direct_parties array (default: [])
• reverse_parties array (default: [])
• consideration number nullable
• deed_doc_tax number nullable
• doc_stamp_tax number nullable
• mers_code string nullable
• submitter_contact string nullable
• return_name string nullable
• return_address string nullable
• case_number string nullable
• linked_documents array (default: [])
  • @type string (default: "NjclerkLinkedDocument")
  • id string required
  • relation string required
  • instrument_number string nullable
  • book string nullable
  • page string nullable
  • book_type string nullable
  • doc_type string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No New Jersey land record under that document id Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.