Create Title Entry - Cardinal Gray API

Create a new title entry

curl --request POST \
  --url https://api.cardinalzyn.com/title \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "attachments": [
    "https://example.com/vehicle-title.pdf",
    "https://example.com/drivers-license.jpg"
  ],
  "account_data": {
    "vehicle": {
      "vin": "1HGCM82633A123456"
    },
    "loan": {
      "borrower": [
        {
          "name": "John Doe",
          "contact_email": "john.doe@example.com",
          "contact_phone": "123-456-7890"
        }
      ]
    }
  },
  "groupId": "branch-5321"
}
'

import requests

url = "https://api.cardinalzyn.com/title"

payload = {
    "attachments": ["https://example.com/vehicle-title.pdf", "https://example.com/drivers-license.jpg"],
    "account_data": {
        "vehicle": { "vin": "1HGCM82633A123456" },
        "loan": { "borrower": [
                {
                    "name": "John Doe",
                    "contact_email": "john.doe@example.com",
                    "contact_phone": "123-456-7890"
                }
            ] }
    },
    "groupId": "branch-5321"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    attachments: [
      'https://example.com/vehicle-title.pdf',
      'https://example.com/drivers-license.jpg'
    ],
    account_data: {
      vehicle: {vin: '1HGCM82633A123456'},
      loan: {
        borrower: [
          {
            name: 'John Doe',
            contact_email: 'john.doe@example.com',
            contact_phone: '123-456-7890'
          }
        ]
      }
    },
    groupId: 'branch-5321'
  })
};

fetch('https://api.cardinalzyn.com/title', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cardinalzyn.com/title",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'attachments' => [
        'https://example.com/vehicle-title.pdf',
        'https://example.com/drivers-license.jpg'
    ],
    'account_data' => [
        'vehicle' => [
                'vin' => '1HGCM82633A123456'
        ],
        'loan' => [
                'borrower' => [
                                [
                                                                'name' => 'John Doe',
                                                                'contact_email' => 'john.doe@example.com',
                                                                'contact_phone' => '123-456-7890'
                                ]
                ]
        ]
    ],
    'groupId' => 'branch-5321'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cardinalzyn.com/title"

	payload := strings.NewReader("{\n  \"attachments\": [\n    \"https://example.com/vehicle-title.pdf\",\n    \"https://example.com/drivers-license.jpg\"\n  ],\n  \"account_data\": {\n    \"vehicle\": {\n      \"vin\": \"1HGCM82633A123456\"\n    },\n    \"loan\": {\n      \"borrower\": [\n        {\n          \"name\": \"John Doe\",\n          \"contact_email\": \"john.doe@example.com\",\n          \"contact_phone\": \"123-456-7890\"\n        }\n      ]\n    }\n  },\n  \"groupId\": \"branch-5321\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.cardinalzyn.com/title")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"attachments\": [\n    \"https://example.com/vehicle-title.pdf\",\n    \"https://example.com/drivers-license.jpg\"\n  ],\n  \"account_data\": {\n    \"vehicle\": {\n      \"vin\": \"1HGCM82633A123456\"\n    },\n    \"loan\": {\n      \"borrower\": [\n        {\n          \"name\": \"John Doe\",\n          \"contact_email\": \"john.doe@example.com\",\n          \"contact_phone\": \"123-456-7890\"\n        }\n      ]\n    }\n  },\n  \"groupId\": \"branch-5321\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cardinalzyn.com/title")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"attachments\": [\n    \"https://example.com/vehicle-title.pdf\",\n    \"https://example.com/drivers-license.jpg\"\n  ],\n  \"account_data\": {\n    \"vehicle\": {\n      \"vin\": \"1HGCM82633A123456\"\n    },\n    \"loan\": {\n      \"borrower\": [\n        {\n          \"name\": \"John Doe\",\n          \"contact_email\": \"john.doe@example.com\",\n          \"contact_phone\": \"123-456-7890\"\n        }\n      ]\n    }\n  },\n  \"groupId\": \"branch-5321\"\n}"

response = http.request(request)
puts response.read_body

{
  "entryId": "550e8400-e29b-41d4-a716-446655440000",
  "job_status": "pending"
}

{
  "error": "<string>",
  "statusCode": 123,
  "disallowedFields": [
    "<string>"
  ]
}

{
  "error": "<string>",
  "statusCode": 123,
  "disallowedFields": [
    "<string>"
  ]
}

{
  "error": "<string>",
  "statusCode": 123,
  "disallowedFields": [
    "<string>"
  ]
}

POST

title

Create a new title entry

curl --request POST \
  --url https://api.cardinalzyn.com/title \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "attachments": [
    "https://example.com/vehicle-title.pdf",
    "https://example.com/drivers-license.jpg"
  ],
  "account_data": {
    "vehicle": {
      "vin": "1HGCM82633A123456"
    },
    "loan": {
      "borrower": [
        {
          "name": "John Doe",
          "contact_email": "john.doe@example.com",
          "contact_phone": "123-456-7890"
        }
      ]
    }
  },
  "groupId": "branch-5321"
}
'

import requests

url = "https://api.cardinalzyn.com/title"

payload = {
    "attachments": ["https://example.com/vehicle-title.pdf", "https://example.com/drivers-license.jpg"],
    "account_data": {
        "vehicle": { "vin": "1HGCM82633A123456" },
        "loan": { "borrower": [
                {
                    "name": "John Doe",
                    "contact_email": "john.doe@example.com",
                    "contact_phone": "123-456-7890"
                }
            ] }
    },
    "groupId": "branch-5321"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    attachments: [
      'https://example.com/vehicle-title.pdf',
      'https://example.com/drivers-license.jpg'
    ],
    account_data: {
      vehicle: {vin: '1HGCM82633A123456'},
      loan: {
        borrower: [
          {
            name: 'John Doe',
            contact_email: 'john.doe@example.com',
            contact_phone: '123-456-7890'
          }
        ]
      }
    },
    groupId: 'branch-5321'
  })
};

fetch('https://api.cardinalzyn.com/title', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cardinalzyn.com/title",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'attachments' => [
        'https://example.com/vehicle-title.pdf',
        'https://example.com/drivers-license.jpg'
    ],
    'account_data' => [
        'vehicle' => [
                'vin' => '1HGCM82633A123456'
        ],
        'loan' => [
                'borrower' => [
                                [
                                                                'name' => 'John Doe',
                                                                'contact_email' => 'john.doe@example.com',
                                                                'contact_phone' => '123-456-7890'
                                ]
                ]
        ]
    ],
    'groupId' => 'branch-5321'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cardinalzyn.com/title"

	payload := strings.NewReader("{\n  \"attachments\": [\n    \"https://example.com/vehicle-title.pdf\",\n    \"https://example.com/drivers-license.jpg\"\n  ],\n  \"account_data\": {\n    \"vehicle\": {\n      \"vin\": \"1HGCM82633A123456\"\n    },\n    \"loan\": {\n      \"borrower\": [\n        {\n          \"name\": \"John Doe\",\n          \"contact_email\": \"john.doe@example.com\",\n          \"contact_phone\": \"123-456-7890\"\n        }\n      ]\n    }\n  },\n  \"groupId\": \"branch-5321\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.cardinalzyn.com/title")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"attachments\": [\n    \"https://example.com/vehicle-title.pdf\",\n    \"https://example.com/drivers-license.jpg\"\n  ],\n  \"account_data\": {\n    \"vehicle\": {\n      \"vin\": \"1HGCM82633A123456\"\n    },\n    \"loan\": {\n      \"borrower\": [\n        {\n          \"name\": \"John Doe\",\n          \"contact_email\": \"john.doe@example.com\",\n          \"contact_phone\": \"123-456-7890\"\n        }\n      ]\n    }\n  },\n  \"groupId\": \"branch-5321\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cardinalzyn.com/title")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"attachments\": [\n    \"https://example.com/vehicle-title.pdf\",\n    \"https://example.com/drivers-license.jpg\"\n  ],\n  \"account_data\": {\n    \"vehicle\": {\n      \"vin\": \"1HGCM82633A123456\"\n    },\n    \"loan\": {\n      \"borrower\": [\n        {\n          \"name\": \"John Doe\",\n          \"contact_email\": \"john.doe@example.com\",\n          \"contact_phone\": \"123-456-7890\"\n        }\n      ]\n    }\n  },\n  \"groupId\": \"branch-5321\"\n}"

response = http.request(request)
puts response.read_body

{
  "entryId": "550e8400-e29b-41d4-a716-446655440000",
  "job_status": "pending"
}

{
  "error": "<string>",
  "statusCode": 123,
  "disallowedFields": [
    "<string>"
  ]
}

{
  "error": "<string>",
  "statusCode": 123,
  "disallowedFields": [
    "<string>"
  ]
}

{
  "error": "<string>",
  "statusCode": 123,
  "disallowedFields": [
    "<string>"
  ]
}

Create a title entry from structured account_data, document URLs, or a raw array of document URLs. If an entry with the same VIN already exists for your organization, Porter updates the existing entry instead of creating a duplicate.

Response Variants

This endpoint returns HTTP 200 for successful creates and updates.

entryId

string

Returned for new entries and for existing entries when enrichment is requested.

job_status

string

pending for new entries, or enriching when an existing VIN is updated and a sync flag was requested.

When an existing VIN is updated without sync flags, the API returns the full patched title entry instead of the minimal {entryId, job_status} response.

Notes

A raw JSON array is accepted as a legacy shorthand for { "attachments": [...] }.
If sync_public or sync_private is requested without an issuing state, the API automatically enables sync_nmvtis.
dppa_exemption is optional on create. When provided, it is passed through to enrichment requests.

Authorizations

Authorization

string

header

required

API key or Clerk JWT supplied as Authorization: Bearer

Body

application/json

Title entry data - either structured AccountData or document URLs for processing

Recommended format: combine document uploads with partial structured data for best results

attachments

string<uri>[]

Array of document URLs to be processed via OCR and data extraction. Supported formats: PDF, JPG, PNG

account_data

object

Additional structured data, such as loan applicant information. Data will be intelligently merged with OCR-extracted data.

Show child attributes

groupId

string

Optional user group ID for organizational access control and workflow routing

sync_nmvtis

boolean

Whether to sync NMVTIS data

sync_public

boolean

Whether to sync public DMV data

sync_private

boolean

Whether to sync private DMV data

dppa_exemption

string

Driver's Privacy Protection Act exemption code. Passed through to enrichment requests when provided; create requests do not validate it as required.

website

string

Accepted for legacy clients but ignored; the organization is derived from authentication.

Response

Title entry created or existing entry updated. The response variant depends on VIN deduplication and requested sync flags.

New entry created; job_status is pending

entryId

string<uuid>

required

Unique identifier for the created title entry

Example:

"550e8400-e29b-41d4-a716-446655440000"

job_status

enum<string>

required

Will be 'pending' for new entries

Available options:

pending,

input_parsing,

enriching,

generating_forms,

complete,

error

Example:

"pending"

List Title Entries

⌘I

​Response Variants

​Notes

Authorizations

Body

Response

Response Variants

Notes