Maryland Bulk eFiling APIs for Landlord Tenant Failure to Rent Cases

Following will give you instructions on how to use APIs to bulk eFile in Maryland court system in Landloard-Tenant Failure to Pay Rent cases. Note: If you are interested in CSV based bulk eFiling, visit here for your options.

1. Request a clienttoken for staging environment by emailing  efile@uslegalpro.com
2. Create a program to do the following:


Description

This is the first step before efiling is to get auth token. The authtoken will be used in the header in subsequent calls.

End Point (POST)

https://{{HOST}}/v2/md/user/authenticate

Header

{clienttoken: XXXXX}

Payload

{

  "data": {

    "username": "{{your md username}}",

    "password": "{{your password}}"

  }

}

Response

{
 "message_code":
0,
 "item": {
   "auth_token":
"fe2c40a7-68dc-476c-acf8-b850fb72e7c0/XPI0001/992af94b- fff2-4e06-a087-34dfc0e3e1542"
 }
}

Description

Create a batch by providing batch name and batch size. You will get a batch id back.

End Point (POST)

https://{{HOST}}/v2/md/batch

Header

{
  "authtoken":
"fe2c40a7-68dc-476c-acf8-b850fb72e7c0/XPI0001/992af94b- fff2-4e06-a087-34dfc0e3e1542"
}

Payload

{

  "data": {

    "name": "{{batch name}}",

    "size": "{{batch size}}"

  }

}

Response

{
  "item":{
     "id":
"1514"
  },
  "message_code":
0
}

Description

eFile each item/row of data in the batch using the api until you reach the batch size from step 2

End Point (POST)

{{HOST}}/v2/{{STATE}}/batch/efile

Header

{
  "authtoken":
"fe2c40a7-68dc-476c-acf8-b850fb72e7c0/XPI0001/992af94b- fff2-4e06-a087-34dfc0e3e1542"
}

Payload

{
 "data": {
   "reference_id":
"{{your unique id for reference purpose only}}",
   "batch_id":
"{{received from step 2}}",
   "sequence":
"{{must be incremental number in the batch}}",
   "jurisdiction":
"{{internal county code}}",
   "case_category":
"{{internal case category code}}",
   "case_type":
"{{internal case type code}}",
   "group_id":
"{{Id given to a group of filings typically in same apartment complex}}",
   "case_parties": [
     {
       "id":
"{{just give a party id in the format Party_random_number}}",
       "type":
"{{internal landlord code }}",
       "first_name":
"{{landlord first name}}",
       "middle_name":
"{{landlord middle name}}",
       "last_name":
"{{landlord last name}}",
       "address_line_1":
"{{landlord address1}}",
       "city":
"{{landlord city}}",
       "state":
"{{landlord state}}",
       "zip_code":
"{{landlord zip}}",
       "is_business":
"false"
     },
     {
       "id":
"Party_71980539",
       "type":
"{{internal landlord agent code }}",
       "first_name":
"{{landloard agent first name}}",
       "middle_name":
"{{landloard agent middle name}}",
       "last_name":
"{{landloard agent last name}}",
       "address_line_1":
"{{landloard agent address1}}",
       "city":
"{{landloard agent city}}",
       "state":
"{{landloard agent state}}",
       "zip_code":
"{{landloard agent zip}}",
       "is_business":
"false"
     },
     {
       "id":
"Party_22961053",
       "type":
"{{internal tenant code }}",
       "first_name":
"{{tenant first name}}",
       "middle_name":
"{{tenant middle name}}",
       "last_name":
"{{tenant last name}}",
       "address_line_1":
"{{tenant address1}}",
       "address_line_2":
"{{tenant address2}}",
       "city":
"{{tenant city}}",
       "state":
"{{tenant state}}",
       "zip_code":
"{{tenant zip}}",
       "is_business":
"false"
     }
   ],
   "filings": [
     {
       "code":
"{{internal filing code}}",
       "description":
"Complaint / Petition - Landlord Tenant - ($ 0)",
       "file":
"{{link to the document}}",
       "doc_type":
"{{internal doc type code}}",
       "optional_services": [
         {
           "code":
"{{internal optional service code}}",
           "quantity":
"0"
         }
       ]
     }
   ],
   "filing_type":
"EFile",
   "payment_account_id":
"{{internal payment account code}}",
   "filing_attorney_id":
"{{internal filing attorney code}}",
   "filing_party_id":
"{{party id who is filing this document}}"
 }

Response

{
 "message_code":
0,
 "item": {
   "id":
"212821",
   "filings": [
     {
       "id":
"22a46ad1-5cc3-47ff-98de-e3bcd98d04fa",
       "code":
"136718",
       "status":
"submitting"
     }
   ]
 }
}

End Point (GET)

{{HOST}}/v2/{{STATE}}/batch/{{batch id from step 2}

Header

{
  "authtoken":
"fe2c40a7-68dc-476c-acf8-b850fb72e7c0/XPI0001/992af94b- fff2-4e06-a087-34dfc0e3e1542"
}

Response

{
 "size":
"2",
 "created_on":
"03/11/2022 01:51 PM CST",
 "identity":
"2468",
 "name":
"BATCH150_2",
 "id":
"4567912",
 "envelopes": [
   {
     "reference_id":
"ABC126",
     "status":
"submitted"
   },
   {
     "reference_id":
"ABC125",
     "status":
"submitted"
   }
 ],
 "envelope_count":
"2"
}

End Point (GET)

{{HOST}}/v2/{{STATE}}/batch/{{batch id from step 2}/download

Header

{
  "authtoken":
"fe2c40a7-68dc-476c-acf8-b850fb72e7c0/XPI0001/992af94b- fff2-4e06-a087-34dfc0e3e1542"
}

Response

Inputstream