{"info":{"_postman_id":"bcf30d8f-667a-43b0-954e-ba69f33fca47","name":"Armantek Name Search Integration","description":"

Armantek Name Search service offers three integration options:

Courtdex Integration API
\n
Webhooks
\n
Hybrid Solution
\n

Courtdex Integration API

Courtdex Integration API allows you to send search orders to Armantek Name Search System and pull the results for your orders. Order results successfully pulled to your system can then be marked as complete in our system in order to notify our system that you have successfully received the results which will prevent them from appearing in future result queries.

Webhooks

Webhooks are URLs to the endpoints on your server. If you choose to integrate to our system through webhooks, Armantek service will automatically call the endpoints on your server in order to pull new search orders, update order's status (if your system requires acknowledgement when Armantek receives orders) and send back the search results to your system. You need to provide the following webhook URLs to our team in order to configure the integration:

Get Search Orders (Required): Armantek system sends POST requests to this webhook URL to receive any new search orders. The response can include one or multiple search orders.
\n
Update Search Order's Status(Optional): Armantek system will send a POST request to this webhook URL to acknowledge that the order was received by our system and passed our validations or failed the validation rules. You may choose not to receive the acknowledgement but we recommend our clients to support the acknowledgement to avoid any confusion.
\n
Upload Search Orders' Results(Required): Armantek system sends a POST request to this webhook URL when a search order is completed and ready to be reported back.
\n
Send Order Errors (Optional, but highly recommended): Armantek system sends a POST request to this webhook URL when an order can not be processed due to the court system's limitation. If this endpoint is not provided by the client, the order will be marked as error in Armantek system. The payload of the request contains ReferenceId of the order and a brief description of the reason that order can not be processed.
{
\"referenceId\": \"REDID-001\",
\"resultStatus\": \"Error\",
\"note\": \"Error Note\",
\"orderStatus\": \"Completed\"
}
\n

Please contact Armantek team to discuss about the format of the requests' and responses' payload.

Hybrid Solution

You can also use the hybrid solution, where your system sends the search orders to Armantek API (either through Send Single Search Order request or Send Multiple Orders request) and order results are pushed to your system via webhooks. In this approach you're only required to provide the webhook URL for sending back the search order results (Upload Search Orders' Results) and can optionally provide a webhook URL for us to send order errors (Send Order Errors).

Service Types

Courtdex system provides two types of search services:

Full Name Search
\n
Hit Clear Name Search
\n

You can define the service type of an order using the ServiceType property in the JSON order. For more information regarding how to send an order, see Send Multiple Search Orders request and Send Single Search Order request.

Where to start

You need a valid API key and user credential in order to integrate to Armantek API and send requests to CourtDex’s server. Please contact Armantek team to acquire your API key and credentials. The API key will be used to authenticate and identify your organization and its orders.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Courtdex Integration API","slug":"courtdex-integration-api"},{"content":"Webhooks","slug":"webhooks"},{"content":"Hybrid Solution","slug":"hybrid-solution"},{"content":"Service Types","slug":"service-types"},{"content":"Where to start","slug":"where-to-start"}],"owner":"3580266","collectionId":"bcf30d8f-667a-43b0-954e-ba69f33fca47","publishedId":"2s8YekQZzg","public":true,"customColor":{"top-bar":"2A3F54","right-sidebar":"2A3F54","highlight":"EF5B25"},"publishDate":"2022-11-10T17:14:33.000Z"},"item":[{"name":"API Authentication","id":"e8c60ecf-b477-4efb-9ab6-26fd62cb77d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json;charset=UTF-8"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_Type","value":"password","type":"text"},{"key":"username","value":"admin@test.com","type":"text"},{"key":"password","value":"AAA123!","type":"text"}]},"url":"https://portal.courtdex.com/token","description":"

Generating a bearer token:

In order to access the APIs, you need to first request a bearer token from the API using your credentials.

{\n    \"grant_type\": \"password\",\n    \"username\": \"user@email.com\",\n    \"password\": \"pwABC123!\"\n}\n

Sample:

var client = new HttpClient(); \nvar request = new HttpRequestMessage \n{ \n    Method = HttpMethod.Post, \n    RequestUri = new Uri(\"http://portal.courtdex.com/token\"), \n    Content = new FormUrlEncodedContent(new Dictionary \n    { \n        { \"grant_type\", \"password\" }, \n        { \"username\", \"user@email.com\" }, \n        { \"password\", \"pwABC123!\" }, \n    }), \n}; \nusing (var response = await client.SendAsync(request)) \n{ \n    response.EnsureSuccessStatusCode(); \n    var body = await response.Content.ReadAsStringAsync(); \n    Console.WriteLine(body); \n}\n

{\n    \"access_token\": \"{access token}\", \n    \"token_type\": \"bearer\", \n    \"expires_in\": 1199, \n    \"refresh_token\": \"{refresh token}\"\n}\n

Accessing protected APIs:

Now that you have a bearer token, it can be used to access protected APIs.
\n
Make a HTTP GET Request to http://portal.courtdex.com/api/{controllerName}/{route} using your access token in the authorization header:
\n
```
{\n    \"token\": \"{access token}\",\n    \"prefix\": \"bearer\"\n}\n
```

Sample:

var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n    Method = HttpMethod.Get,\n    RequestUri = new Uri(\"http://portal.courtdex.com/api/usersApi/GetSystemRoleList\"),\n    Headers =\n    {\n        { \"authorization\", \"bearer abc-123tokentokentoken\" },\n    },\n};\n\nusing (var response = await client.SendAsync(request))\n{\n   response.EnsureSuccessStatusCode();\n   var body = await response.Content.ReadAsStringAsync();\n   Console.WriteLine(body);\n}\n

Generating a bearer token using the refresh token:

Your original bearer token will last 20 minutes before it expires. The benefit of using a refresh token to generate a new bearer token is that you do not have to provide your credentials anymore.
\n

Make a HTTP POST Request to http://portal.courtdex.com/token with the following form data:

{\n    \"grant_type\": \"refresh_token\",\n    \"refresh_token\": \"{refresh token that was obtained with the original bearer token}\"\n}\n

Sample:

var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n    Method = HttpMethod.Post,\n    RequestUri = new Uri(\"http://portal.courtdex.com/token\"),\n    Content = new FormUrlEncodedContent(new Dictionary\n    {\n        { \"grant_type\", \"refresh_token\" },\n        { \"refresh_token\", \"def-456refreshtokenrefreshtokenrefreshtoken\" },\n    }),\n};\nusing (var response = await client.SendAsync(request))\n{\n    response.EnsureSuccessStatusCode();\n    var body = await response.Content.ReadAsStringAsync();\n    Console.WriteLine(body);\n}\n

{ \n     \"access_token\": \"{access token}\",\n     \"token_type\": \"bearer\",\n     \"expires_in\": 1199,\n     \"refresh_token\": \"{refresh token}\" \n}\n

\n","urlObject":{"protocol":"https","path":["token"],"host":["portal","courtdex","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e8c60ecf-b477-4efb-9ab6-26fd62cb77d4"},{"name":"Send Multiple Search Orders","id":"56958699-fa62-4248-9d1b-79ed2e3c122f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","type":"text"}],"body":{"mode":"raw","raw":""},"url":"http://portal.courtdex.com/integrationApi/AddOrders","description":"

Description

This Request is used to add one or multiple search orders to CourtDex’s Name Search System.

Example Content, Search By Fips

{\n    \"apiKey\": \"API_KEY_PROVIDED_BY_ARMANTEK\",\n    \"orders\": [{\n        \"person\": {\n            \"firstName\": \"John\",\n            \"middleName\": \"A\",\n            \"lastName\": \"Smith\",\n            \"suffix\": \"Jr\",\n            \"address\": \"123 Main rd\",\n            \"aptNo\": \"333\",\n            \"city\": \"Fredrick\",\n            \"state\": \"Maryland\",\n            \"zipCode\": \"12345\",\n            \"county\": \"Fredrick\",\n            \"isFemale\": \"false\",\n            \"licenseNumber\": \"45673\",\n            \"licenseState\": \"MD\",\n            \"ssn\": \"XXX-XX-1234\",\n            \"birthDate\": \"1976-07-10T00:00:00-04:00\",\n            \"aliases\": [{\n                \"firstName\": \"Theodore\",\n                \"middleName\": \"A\",\n                \"lastName\": \"Craven\",\n                \"suffix\": \"Jr\"\n            }],\n        },\n        \"referenceId\": \"REFID-001\",\n        \"serviceType\":\"FullNameSearch\",\n        \"orderType\": \"Criminal\",\n        \"fips\": \"24021\",\n        \"scope\": \"10 Years\",\n        \"orderNotes\": \"test Note\",        \n        \"orderState\":,\n        \"orderJurisdiction\":,\n        \"orderFlags\":0,\n        \"disclosure\": \"Theft offense in 2009 in Baltimore County\"\n    }]\n}\n\n

Example Content, Search By State and Jurisdiction

{\n    \"apiKey\": \"API_KEY_PROVIDED_BY_ARMANTEK\",\n    \"orders\": [{\n        \"person\": {\n            \"firstName\": \"Ted\",\n            \"middleName\": \"A\",\n            \"lastName\": \"Brown\",\n            \"suffix\": \"Jr\",\n            \"address\": \"345 Main rd\",\n            \"aptNo\": \"222\",\n            \"city\": \"Baltimore\",\n            \"state\": \"Maryland\",\n            \"zipCode\": \"21201\",\n            \"county\": \"Baltimore\",\n            \"isFemale\": \"false\",\n            \"licenseNumber\": \"12345\",\n            \"licenseState\": \"MD\",\n            \"ssn\": \"XXX-XX-5678\",\n            \"birthDate\": \"1986-07-10T00:00:00-04:00\",\n            \"aliases\": [{\n                \"firstName\": \"Sam\",\n                \"middleName\": \"\",\n                \"lastName\": \"B\",\n                \"suffix\": \"Jr\"\n            }],\n        },\n        \"referenceId\": \"RefId-002\",\n        \"serviceType\":\"FullNameSearch\",\n        \"orderType\": \"Criminal\",\n        \"fips\":,\n        \"scope\": \"8 Years\",\n        \"orderNotes\": \"test Note\",        \n        \"orderState\": \"Maryland\",\n        \"orderJurisdiction\": \"Baltimore\",\n        \"orderFlags\":0,\n        \"disclosure\": \"Theft offense in 2009 in Orange County\"\n    }]\n}\n\n

Additional Notes

Following fields are required:
- ReferenceId*, Fips, FirstName, LastName, BirthDate.
\n
The ReferenceId is the order unique identifier in the client’s system. It can be used by the client to identify the results returned from Get Ready Results requests and mark orders as complete.
ServiceType is the type of the service requested for the order which can be any of the following two values:
1. FullNameSearch if the order is a name search background check
2. HitClearNameSearch if the order is a hit/clear check
\n
Fips is an integer used to identify the jurisdiction being searched. For a complete list of available CourtDex Fips, contact Armantek team to receive CourtDex’s Fips Table.
A request may contain Fips (as shown in the first Order in the example) or combination of OrderState and OrderJurisdiction (As shown in the second order in the example). Api first looks for the Fips in the order and if no Fips is provided, it will use the values in OrderState and OrderJurisdiction to assign Fips for the order.
A request may contain multiple orders stored in the Orders element, which is an array of ArmantekOrder(s). For a complete list of available CourtDex OrderStates and OrderJurisdictions, contact Armantek team to receive CourtDex’s Jurisdiction Table.
Aliases element is an array of Alias(es).
OrderFlags: For the list of order flags supported by the API, contact Armantek team.

Response

We support two types of responses:

Armantek default response: The response of the request will always have HTTP Status 200 and the payload will include the error messages for the orders that failed our validations. For more information please check ArmantekNameSearchResponse.
\n
HTTP response: Clients can request to receive the error messages through http errors. To receive the response in this format, contact Armantek team. Following are the http statuses supported by courtdex system:
\n
- HTTP status 400: System returns this status if order fails validation rules. The payload of the response will contain more details of the failed validations.
- HTTP status 401: System returns this status if authentication token is no longer valid or the passed api key or credentials are not valid.
- HTTP status 500: System returns this status if an unexpected error happened while adding the order to Courtdex system.
\n

ArmantekNameSearchResponse

This is the response that will be returned by Send Search Request and Mark Order Complete.

Example when request processed successfully

{\n    \"errors\": [],\n    \"status\": \"OK\"\n}\n\n

Example when Send Search Request failed with errors

{\n    \"errors\": [\n        {\n            \"referenceId\": \"testDuplicate\",\n            \"error\": \"Duplicated Order\"\n        }\n    ],\n    \"status\": \"OK\"\n}\n\n

\n","urlObject":{"protocol":"http","path":["integrationApi","AddOrders"],"host":["portal","courtdex","com"],"query":[],"variable":[]}},"response":[{"id":"bfd48735-172d-4c33-be3d-f6a50e50fe04","name":"Example2 when there are errors (for ArmantekNameSearchRequest)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"apiKey\": \"API_KEY_PROVIDED_BY_ARMANTEK\",\r\n \"orders\": [{\r\n \"person\": {\r\n \"aliases\": [],\r\n \"firstName\": \"Sara\",\r\n \"lastName\": \"Smith\",\r\n \"birthDate\": \"2000-07-09T00:00:00-04:00\"\r\n },\r\n \"referenceId\": \"testDuplicate\",\r\n \"fips\": \"24001\"\r\n }]\r\n}"},"url":"http://portal.courtdex.com/integrationApi/AddOrders"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Allow","value":"POST","name":"Allow","description":""},{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"72","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 22 Jan 2018 22:01:57 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"referenceId\": \"RefID001\",\n \"error\": \"Duplicated Order\"\n }\n ],\n \"status\": \"OK\"\n}"},{"id":"cc543789-9e2a-42b5-ac4e-fac362ee2b10","name":"Example when there are errors (for ArmantekNameSearchOrderCompleteRequest)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"apiKey\": \"API_KEY_PROVIDED_BY_ARMANTEK\",\r\n \"orders\": [{\r\n \"person\": {\r\n \"firstName\": \"\",\r\n \"middleName\": \"A\",\r\n \"lastName\": \"Smith\",\r\n \"suffix\": \"Jr\",\r\n \"address\": \"123 Main rd\",\r\n \"aptNo\": \"333\",\r\n \"city\": \"Fredrick\",\r\n \"state\": \"Maryland\",\r\n \"zipCode\": \"12345\",\r\n \"county\": \"Fredrick\",\r\n \"isFemale\": \"false\",\r\n \"licenseNumber\": \"45673\",\r\n \"licenseState\": \"MD\",\r\n \"ssn\": \"XXX-XX-1234\",\r\n \"birthDate\": \"1976-07-10T00:00:00-04:00\",\r\n \"aliases\": [{\r\n \"firstName\": \"Theodore\",\r\n \"middleName\": \"A\",\r\n \"lastName\": \"Craven\",\r\n \"suffix\": \"Jr\"\r\n }],\r\n },\r\n \"referenceId\": \"testMissingFirstName\",\r\n \"fips\": \"24021\",\r\n \"scope\": \"10 Years\",\r\n \"orderNotes\": \"test Note\",\r\n \"orderType\": \"Criminal\",\r\n \"orderState\": null,\r\n \"orderJurisdiction\": null\r\n }]\r\n}"},"url":"http://portal.courtdex.com/integrationApi/AddOrders"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Allow","value":"POST","name":"Allow","description":""},{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"72","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 22 Jan 2018 22:01:57 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"referenceId\": \"RefID-002\",\n \"error\": \"Missing Required Field\"\n }\n ],\n \"status\": \"OK\"\n}"},{"id":"074e7caa-368c-4703-85b2-83e15ea5f270","name":"Example Content when OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"apiKey\": \"API_KEY_PROVIDED_BY_ARMANTEK\",\r\n \"orders\": [{\r\n \"person\": {\r\n \"firstName\": \"John\",\r\n \"middleName\": \"A\",\r\n \"lastName\": \"Smith\",\r\n \"suffix\": \"Jr\",\r\n \"address\": \"123 Main rd\",\r\n \"aptNo\": \"333\",\r\n \"city\": \"Fredrick\",\r\n \"state\": \"Maryland\",\r\n \"zipCode\": \"12345\",\r\n \"county\": \"Fredrick\",\r\n \"isFemale\": \"false\",\r\n \"licenseNumber\": \"45673\",\r\n \"licenseState\": \"MD\",\r\n \"ssn\": \"XXX-XX-1234\",\r\n \"birthDate\": \"1976-07-10T00:00:00-04:00\",\r\n \"aliases\": [{\r\n \"firstName\": \"Theodore\",\r\n \"middleName\": \"A\",\r\n \"lastName\": \"Craven\",\r\n \"suffix\": \"Jr\"\r\n }],\r\n },\r\n \"referenceId\": \"testOk\",\r\n \"fips\": \"24021\",\r\n \"scope\": \"10 Years\",\r\n \"orderNotes\": \"test Note\",\r\n \"orderType\": \"Criminal\",\r\n \"orderState\": null,\r\n \"orderJurisdiction\": null\r\n }]\r\n}"},"url":"http://portal.courtdex.com/integrationApi/AddOrders"},"status":"Ok custome response","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Allow","value":"POST","name":"Allow","description":""},{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"72","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 22 Jan 2018 22:01:57 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [],\n \"status\": \"OK\"\n}"},{"id":"c681bceb-d5d8-4e56-94e5-26aec1554845","name":"Example Search By State And Jurisdiction Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"apiKey\": \"API_KEY_PROVIDED_BY_ARMANTEK\",\r\n \"orders\": [{\r\n \"person\": {\r\n \"firstName\": \"Ted\",\r\n \"middleName\": \"A\",\r\n \"lastName\": \"Brown\",\r\n \"suffix\": \"Jr\",\r\n \"address\": \"345 Main rd\",\r\n \"aptNo\": \"222\",\r\n \"city\": \"Baltimore\",\r\n \"state\": \"Maryland\",\r\n \"zipCode\": \"21201\",\r\n \"county\": \"Baltimore\",\r\n \"isFemale\": \"false\",\r\n \"licenseNumber\": \"12345\",\r\n \"licenseState\": \"MD\",\r\n \"ssn\": \"XXX-XX-5678\",\r\n \"birthDate\": \"1986-07-10T00:00:00-04:00\",\r\n \"aliases\": [{\r\n \"firstName\": \"Sam\",\r\n \"middleName\": \"\",\r\n \"lastName\": \"B\",\r\n \"suffix\": \"Jr\"\r\n }],\r\n },\r\n \"referenceId\": \"testSearchWithJurisdiction\",\r\n \"fips\": \"24021\",\r\n \"scope\": \"8 Years\",\r\n \"orderNotes\": \"test Note\",\r\n \"orderType\": \"Criminal\",\r\n \"orderState\": \"Maryland\",\r\n \"orderJurisdiction\": \"Baltimore\"\r\n }]\r\n}"},"url":"http://10.1.10.165/courtdex-test/integrationApi/AddOrders"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 26 Apr 2019 21:35:32 GMT"},{"key":"Content-Length","value":"27"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [],\n \"status\": \"OK\"\n}"}],"_postman_id":"56958699-fa62-4248-9d1b-79ed2e3c122f"},{"name":"Get Ready Results","id":"2565ead6-6f01-4cf7-b4aa-d488587555cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","type":"text"}],"url":"http://portal.courtdex.com/integrationApi/GetReadyResults","description":"

Description

This request returns the results of orders that were processed after the time requested in the LastResponseTime parameter and are not already marked as completed by the client's system. The maximum number of results returned in the response of this request is 25. In order to receive all the results, client systems need to send subsequent requests with the lastResponseTime value returned in order to retrieve the results of the searches that have been processed.

Example Content

{\n    \"apiKey\":\"API_KEY_PROVIDED_BY_ARMANTEK\",\n    \"lastResponseTime\":\"2019-04-26T12:44:00-04:00\"\n}\n\n

Additional Notes

Generally, the value of LastResponseTime should be the ResponseTime value returned in the last ArmantekNameSearchResultsResponse.

Response

ArmantekNameSearchResultsResponse

ResponseTime value is the date and time when the most recent result was processed and returned to the client. ResponseTime needs to be kept by the client system and sent in the next ArmantekNameSearchResultsRequest.
Status holds the status of the request. Unless an unexpected error happened, system will return \"OK\" as the status. Otherwise the error will be returned in this field.
OrderResults is an array of ArmantekNameSearchOrderResults. Each item in this array is the result of an order which have been processed after the requested LastResponseTime and have not been marked as completed by the client.

ArmantekNameSearchOrderResults

ReferenceId is the id of the order sent by the client system.
OrderStatus holds the status of the order, which is always Completed.
ResultStatus holds the status of the search result which can be any of the following values:
- Hit: If search had at least one result
-Clear: If the search had no result
-Error: If the search could not be processed due to an error. If a search failed due to an error the Note field will hold more information regarding the error. You can find an example of the response for orders which were marked as errors in the Example section.
ResultCases is an array of ResultCase. ResultCase Contains an array of Charge element called Charges.
If the service type of an order is HitClearNameSearch, resultCases will be empty if search was Clear. In case the search was Hit, ResultCases will hold only one element which will be a template case.

\n","urlObject":{"protocol":"http","path":["integrationApi","GetReadyResults"],"host":["portal","courtdex","com"],"query":[],"variable":[]}},"response":[{"id":"13472948-57ba-4210-a4ae-42dc4cf39a4c","name":"ArmantekNameSearchResultsResponse ","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json;charset=UTF-8","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"apiKey\": \"API_KEY_PROVIDED_BY_ARMANTEK\",\r\n \"lastResponseTime\": \"2019-04-29T13:20:00-04:00\"\r\n}"},"url":"http://portal.courtdex.com/integrationApi/GetReadyResults"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"responseTime\": \"2019-04-29T13:55:57.63Z\",\r\n \"orderResults\": [\r\n {\r\n \"referenceId\": \"REFID-001\",\r\n \"resultCases\": [\r\n {\r\n \"address\": \"4009 KAHLSTON RD\",\r\n \"age\": 0,\r\n \"agency\": \"\",\r\n \"aliases\": \"\",\r\n \"bday\": 0,\r\n \"bmonth\": 10,\r\n \"byear\": 1977,\r\n \"caseOtherData\": \"\",\r\n \"caseStatus\": \"Closed\",\r\n \"caseSubType\": \"\",\r\n \"caseType\": \"Citation - Traffic\",\r\n \"city\": \"BALTIMORE\",\r\n \"closedDate\": \"0001-01-01T00:00:00Z\",\r\n \"concludedBy\": \"\",\r\n \"court\": \"Towson District Court\",\r\n \"courtTime\": \"0001-01-01T00:00:00Z\",\r\n \"defendentStatus\": \"\",\r\n \"dob\": \"Partial BirthDate: 10/xx/1977\",\r\n \"docketDataUrl\": \"#/viewDoc?contentId=1f902366-fa2f-4d03-a52f-1b07a3989f97&searchType=6&courtTypeId=24\",\r\n \"eventPlace\": \"\",\r\n \"eyeColor\": \"\",\r\n \"fileDate\": \"2016-08-29T00:00:00Z\",\r\n \"caseNo\": \"2DH0E30\",\r\n \"firstName\": \"Helen\",\r\n \"gender\": \"Female\",\r\n \"hairColor\": \"\",\r\n \"hasWarrant\": false,\r\n \"hearingDate\": \"0001-01-01T00:00:00Z\",\r\n \"hearingResult\": \"\",\r\n \"hearingType\": \"\",\r\n \"height\": \"5'5\\\"\",\r\n \"isCitizen\": false,\r\n \"judge\": \"\",\r\n \"judgement\": \"\",\r\n \"lastName\": \"Smith\",\r\n \"licenseNumber\": \"\",\r\n \"licenseState\": \"\",\r\n \"matchPoints\": 10,\r\n \"middleName\": \"Mary\",\r\n \"notes\": \"\",\r\n \"officer\": \"\",\r\n \"officerId\": \"\",\r\n \"prosecutor\": \"\",\r\n \"race\": \"White\",\r\n \"relatedFileNo\": \"\",\r\n \"ssn\": \"\",\r\n \"state\": \"MD\",\r\n \"suffix\": \"\",\r\n \"trafficPoints\": \"\",\r\n \"weight\": \"135 lbs\",\r\n \"zipCode\": \"21236\",\r\n \"charges\": [\r\n {\r\n \"dispositionDateStr\": \"10/20/2016\",\r\n \"offenseDate\": \"2016-08-26T00:00:00Z\",\r\n \"arrestDate\": \"0001-01-01T00:00:00Z\",\r\n \"speedLimit\": 0,\r\n \"convictedSpeed\": 0,\r\n \"allFees\": \"Fine: $14.50 | Court Costs: $25.50\",\r\n \"isRemoved\": false,\r\n \"charge\": \"EXCEEDING MAXIMUM SPEED: 64 MPH IN A POSTED 55 MPH ZONE\",\r\n \"chargeCode\": \"TA.21.801.1\",\r\n \"chargeNumber\": \"\",\r\n \"restitutionAmount\": 0,\r\n \"restitutionPaid\": \"\",\r\n \"sentenceServedType\": \"\",\r\n \"jailType\": \"\",\r\n \"appealedDate\": \"0001-01-01T00:00:00Z\",\r\n \"suspendedCourtCosts\": 0,\r\n \"pbjEndDate\": \"0001-01-01T00:00:00Z\",\r\n \"otherFees\": 0,\r\n \"suspendedOtherFees\": 0,\r\n \"fineSuspended\": 0,\r\n \"finePaidStatus\": \"\",\r\n \"fineOwed\": 0,\r\n \"amendedPlea\": \"\",\r\n \"jailPrisonSentence\": \"\",\r\n \"amendedRestrictions\": \"\",\r\n \"restrictions\": \"\",\r\n \"probations\": \"\",\r\n \"amendedProbations\": \"\",\r\n \"fees\": \"\",\r\n \"amendedFees\": \"\",\r\n \"services\": \"\",\r\n \"amendedServices\": \"\",\r\n \"amendedSentence\": \"\",\r\n \"citationNo\": \"\",\r\n \"sentenceEndDate\": \"0001-01-01T00:00:00Z\",\r\n \"judgementDate\": \"0001-01-01T00:00:00Z\",\r\n \"appeal\": \"\",\r\n \"sentences\": \"\",\r\n \"amendedSentences\": \"\",\r\n \"amendedSentenceSuspendedTime\": \"\",\r\n \"bondAmount\": 0,\r\n \"offenseLevel\": \"\",\r\n \"offenseClass\": \"\",\r\n \"plea\": \"Guilty\",\r\n \"disposition\": \"Probation Before Judgment\",\r\n \"dispositionDate\": \"2016-10-20T00:00:00Z\",\r\n \"finding\": \"\",\r\n \"accident\": false,\r\n \"bloodAlcoholLevel\": \"\",\r\n \"pleaDate\": \"0001-01-01T00:00:00Z\",\r\n \"sentenceSuspendedTime\": \"\",\r\n \"unsuspendedSentence\": \"\",\r\n \"probationStarts\": \"0001-01-01T00:00:00Z\",\r\n \"probationStartsAt\": \"\",\r\n \"restrictionStartDate\": \"0001-01-01T00:00:00Z\",\r\n \"restrictionEndDate\": \"0001-01-01T00:00:00Z\",\r\n \"probationType\": \"\",\r\n \"alcoholProgram\": \"\",\r\n \"probationTime\": \"\",\r\n \"licenseSuspensionTime\": \"\",\r\n \"fine\": 14.5,\r\n \"fineDue\": 0,\r\n \"courtCosts\": 25.5,\r\n \"operatorLicenseRestrictionCodes\": \"\",\r\n \"otherData\": \"\",\r\n \"amendedCharge\": \"\",\r\n \"amendedChargeCode\": \"\",\r\n \"amendedOffenseLevel\": \"\",\r\n \"chargeDate\": \"0001-01-01T00:00:00Z\",\r\n \"sentenceDate\": \"0001-01-01T00:00:00Z\",\r\n \"sentenceStartDate\": \"0001-01-01T00:00:00Z\",\r\n \"finePaidDate\": \"0001-01-01T00:00:00Z\",\r\n \"sentenceSuspendedFor\": \"\",\r\n \"amendedSentenceSuspendedFor\": \"\",\r\n \"statute\": \"TA.21.801.1\",\r\n \"amendedStatute\": \"\",\r\n \"dispositions\": \"\"\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n ],\r\n \"status\": \"OK\"\r\n}"},{"id":"148e2c8e-0e5c-4a13-8317-fee06a426128","name":"Hit Clear Name Search Order Result","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"apiKey\": \"API_KEY_PROVIDED_BY_ARMANTEK\",\r\n \"lastResponseTime\": \"2019-04-29T13:20:00-04:00\"\r\n}"},"url":"http://portal.courtdex.com/integrationApi/GetReadyResults"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"responseTime\": \"2023-02-01T12:48:35.857Z\",\r\n \"orderResults\": [\r\n {\r\n \"referenceId\": \"REFID-TEST-002\",\r\n \"orderStatus\": \"Completed\",\r\n \"resultStatus\": \"Hit\",\r\n \"note\": \"\",\r\n \"resultCases\": [\r\n {\r\n \"aliases\": \"\",\r\n \"bday\": 29,\r\n \"bmonth\": 1,\r\n \"byear\": 1993,\r\n \"court\": \"Dallas\",\r\n \"dob\": \"01/29/1993\",\r\n \"fileDate\": \"2023-02-01T00:00:00Z\",\r\n \"caseNo\": \"33d7fa0a\",\r\n \"firstName\": \"Emmanuel\",\r\n \"lastName\": \"Carmouche\",\r\n \"matchPoints\": 95,\r\n \"middleName\": \"\",\r\n \"suffix\": \"\",\r\n \"charges\": [\r\n {\r\n \"dispositionDateStr\": \"\",\r\n \"allFees\": \"\",\r\n \"refId\": \"0ebc9ec4-c08c-42b9-882c-5223fe9b887a\",\r\n \"charge\": \"Please contact court for records on this subject.\",\r\n \"chargeNumber\": \"1\"\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n ],\r\n \"status\": \"OK\"\r\n}"},{"id":"14ac2809-2594-4e4b-8504-789ccdeaac99","name":"Orders marked as error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","type":"text"}],"url":"http://portal.courtdex.com/integrationApi/GetReadyResults"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"responseTime\": \"2021-02-01T18:40:57.01Z\",\r\n \"orderResults\": [\r\n {\r\n \"referenceId\": \"REFID-TEST-002\",\r\n \"orderStatus\": \"Completed\",\r\n \"resultStatus\": \"Error\",\r\n \"note\": \"Order has a one letter last name in aliases.\"\r\n },\r\n {\r\n \"referenceId\": \"REFID-TEST-006\",\r\n \"orderStatus\": \"Completed\",\r\n \"resultStatus\": \"Error\",\r\n \"note\": \"Court does not support one letter first name (in order's alias).\"\r\n }\r\n ],\r\n \"status\": \"OK\"\r\n}"}],"_postman_id":"2565ead6-6f01-4cf7-b4aa-d488587555cb"},{"name":"Mark Order Complete","id":"018e3c40-7884-410a-a8f3-b8a6e029dea3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json; charset=utf-8"}],"body":{"mode":"raw","raw":"{\r\n \"apiKey\":\"76D22723-7946-481A-ACBC-0EACA8E87519\",\r\n \"completedReferenceIds\": [\"REFID-TEST-600\",\"REFID-TEST-200\"]\r\n}"},"url":"http://portal.courtdex.com/integrationApi/SetResultCompleted","description":"

Description

This request is used to notify CourtDex’s server that the results of processed orders have been received by the client’s system. CourtDex’s server will mark these orders as completed and will not return them in response to future Get Ready Results requests.

Example Content

{\n    \"apiKey\": \"API_KEY_PROVIDED_BY_ARMANTEK\",\n    \"completedReferenceIds\": [\"RefID-001\"]\n}\n\n

Response

ArmantekNameSearchResponse

This response will also be returned by Send Multiple Search Orders.

Example when request processed successfully

{\n    \"errors\": [],\n    \"status\": \"OK\"\n}\n\n

Example when Mark Order Complete failed with errors

{\n    \"errors\": [],\n    \"status\": \"No Reference Id was found in the request\"\n}\n\n

\n","urlObject":{"protocol":"http","path":["integrationApi","SetResultCompleted"],"host":["portal","courtdex","com"],"query":[],"variable":[]}},"response":[{"id":"fb21e8da-acfa-4b67-99d3-13ec3d81e3c2","name":"Example when there are errors (for ArmantekNameSearchOrderCompleteRequest)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json; charset=utf-8","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"apiKey\":\"API_KEY_PROVIDED_BY_ARMANTEK\",\n\t\"completedReferenceIds\":[\"wrongRefIdTest\"]\n}"},"url":"http://portal.courtdex.com/integrationApi/SetResultCompleted"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"errors\": [\r\n {\r\n \"referenceId\": \"RefID-100\",\r\n \"error\": \"Reference Id not found\"\r\n }\r\n ],\r\n \"status\": \"Processed With Error\"\r\n}"},{"id":"36f85697-8b86-4625-8f82-09191d084d59","name":"Example Content when OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json; charset=utf-8","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"apiKey\": \"API_KEY_PROVIDED_BY_ARMANTEK\",\r\n \"completedReferenceIds\": [\"MarkOrderTest\"]\r\n}"},"url":"http://portal.courtdex.com/integrationApi/SetResultCompleted"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"errors\": [],\r\n \"status\": \"OK\"\r\n}"}],"_postman_id":"018e3c40-7884-410a-a8f3-b8a6e029dea3"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"ed8fff2c-1078-4b0f-989c-7d7d709b0b0e"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"27902420-20c5-467e-b3bd-b0689c9a6321"}}]}