Social Security card

A Social Security card is a government-issued document displaying an individual's name and unique national ID number.

The form_type parameter SOCIAL_SECURITY_CARD for the Upload PDF endpoint is required for this Form Type.

Learn more about how we process social security cards here.

📘

Configuration-driven output

All fields below are optionally captured, depending on your order form. To adjust fields captured, please speak with your Ocrolus Account Manager.

JSON attribute

Data type

Description

social_security_card-General:firstName

Text

First name of the individual

social_security_card-General:middleName

Text

Middle name of the individual

social_security_card-General:lastName

Text

Last name of the individual

social_security_card-General:suffix

Text

Default is_empty = TRUE, Suffix of the individual

social_security_card-General:number

Text

Formatted XXX-XX-XXXX. Social Security Number issued to the individual

Sample form

The below Ocrolus sample PDF (input) matches the below sample JSON result (output).

Sample JSON result

{
  "status": 200,
  "response": {
    "pk": 30476609,
    "uuid": "e146a8c4-0c7b-4ce3-a523-607dfb6b1a9f",
    "forms": [
      {
        "pk": 30029183,
        "uuid": "e476a524-cf4e-497a-9b48-9ab1f82d45b5",
        "form_type": "SOCIAL_SECURITY_CARD",
        "form_config_pk": 18854,
        "tables": [],
        "raw_fields": {
          "social_security_card-General:number": {
            "value": "854-65-9582",
            "is_empty": false,
            "alias_used": null,
            "source_filename": "Social Security Card Sample 1.pdf"
          },
          "social_security_card-General:suffix": {
            "value": "",
            "is_empty": true,
            "alias_used": null,
            "source_filename": "Social Security Card Sample 1.pdf"
          },
          "social_security_card-General:lastName": {
            "value": "ARON",
            "is_empty": false,
            "alias_used": null,
            "source_filename": "Social Security Card Sample 1.pdf"
          },
          "social_security_card-General:firstName": {
            "value": "ELVISH",
            "is_empty": false,
            "alias_used": null,
            "source_filename": "Social Security Card Sample 1.pdf"
          },
          "social_security_card-General:middleName": {
            "value": "",
            "is_empty": true,
            "alias_used": null,
            "source_filename": "Social Security Card Sample 1.pdf"
          }
        }
      }
    ]
  },
  "message": "OK"
}

Did this page help you?