---
title: "Scra Search"
method: POST
path: "/scra/searches"
tags: ["SCRA & MLA"]
---

# Scra Search

`POST /scra/searches`

## Request body

- V1SCRASearchRequest
  - `parse_permutate_options` V1ParsePermutateOptions
    - `keep_original` boolean, nullable — Allows original name to be searched even in case of name containing known words along with any name variations generated
    - `first_name_remove_list` string, nullable — CSV list of string values to remove from first name
    - `last_name_remove_list` string, nullable — CSV list of string values to remove from last name
    - `middle_name_parse` 'None' | 'Share' | 'ShareMerge' | 'AppendMiddleInitial' | 'AppendMiddleInitialAll'
    - `force_hyphen` boolean, nullable — Generates additional name variations only on two part last names delimited by a spaces replacing the space with a hyphen
    - `include_suffix` 'None' | 'OriginalOnly' | 'All'
    - `parse_prefix` boolean, nullable — Attempts to locate and remove Prefix out of the first name
    - `parse_suffix` boolean, nullable — Attempts to locate and remove Suffix out of the last name
    - `max_permutation_count` integer, nullable — Sets maximum amount of permutations. Default is 50
    - `merge_name_parts` boolean, nullable — Merges compound name parts into a single name. Merging occurs on any number of name parts provided
    - `mixed_case_split` boolean, nullable
    - `suppress_hyphen_parse` 'Never' | 'MultipleOnly' | 'Always'
    - `toggle_middle_name` boolean, nullable — Ability to generate name variations with/without middle name
    - `toggle_primary_name` boolean, nullable — Ability to generate name variations with/without first name
    - `transpose` boolean, nullable — Transposes name parts to generate all unique variations. Transposing occurs on any number of name parts provided
    - `validate_permutation_count` boolean, nullable
    - `remove_nobiliary_participle` boolean, nullable
    - `parse_model` 'NameSegmentParse' | 'None'
  - `certificate` boolean — Indicates if DMDC certificate should be included in response. Defaults to False
  - `reference_id` string, nullable — An optional reference ID to associate with the search request.
  - `first_name` string, required — The first name of the person of interest
  - `last_name` string, required — The last name of the person of interest
  - `middle_name` string, nullable — The middle name of the person of interest
  - `birth_date` string, date, nullable — The birth date of the person of interest. No dates before 1900-01-01 or in the future
  - `ssn` string, password, required — The social security number of the person of interest
  - `date_of_interest` string, date — The date queried to determine the status of the individual; to check whether the individual was actively serving, received a notice to serve, or was serving 367 days prior to the given date, or not. Date must be on or after 1985-09-30 and cannot be a future date. Default to today.

## Response `200`

Response

- V1SCRAResponse
  - `reference_id` string, nullable — The reference ID associated with the search.
  - `covered` boolean, required — This indicates if any of the searches performed contained SCRA coverage
  - `results` V1SCRAResponseResult[], nullable — List of SCRA search results
    - `id` string, nullable — DMDC TransactionID
    - `person_request` V1SCRAResponsePerson, required
      - `pn_id` string, nullable — Either a social security number (SSN) or an individual taxpayer identification number (ITIN)
      - `pn_id_confirmation` string, nullable
      - `first_name` string, nullable — The first name of the person of interest as provided in the request
      - `last_name` string, nullable — The last name of the person of interest as provided in the request
      - `middle_name` string, nullable — The middle name of the person of interest as provided in the request
      - `date_of_birth` string, date-time, nullable — The date of birth of the person of interest as provided in the request
      - `active_duty_date` string, date-time, nullable — This is the active duty status as of the date provided in the request
      - `cadency_name` string, nullable
      - `batch_id` string, nullable
    - `eligibility` V1SCRAResponseEligibility, required
      - `covered` boolean, required — This indicates if the person was on active duty on the active duty status date
      - `transaction_id` string, nullable — DMDC TransactionID / CertificateID
      - `content` string, nullable — Base64 content of DMDC Certificate
      - `date_of_interest` string, date-time, nullable
      - `active_duty_covered` boolean, required — This indicates if the person was on active duty on the active duty status date
      - `active_duty_start_date` string, date-time, nullable — The date the servicemember entered active duty
      - `active_duty_end_date` string, date-time, nullable — The date the servicemember ended active duty
      - `active_duty_service_component_code` 'AG' | 'AJ' | 'AR' | 'AV' | 'AZ' | 'CJ' | 'CR' | 'CV' | 'CZ' | 'FG' | 'FJ' | 'FR' | 'FV' | 'HR' | 'MR' | 'MV' | 'MZ' | 'NJ' | 'NR' | 'NV' | 'OR' | 'SR' | 'SV' | 'ZZ'
      - `active_duty_service_component_string` string, nullable
      - `early_indication_covered` boolean, required
      - `early_indication_start_date` string, date-time, nullable — The start date of the order notification
      - `early_indication_end_date` string, date-time, nullable — The end date of the order notification
      - `early_indication_service_component_code` 'AG' | 'AJ' | 'AR' | 'AV' | 'AZ' | 'CJ' | 'CR' | 'CV' | 'CZ' | 'FG' | 'FJ' | 'FR' | 'FV' | 'HR' | 'MR' | 'MV' | 'MZ' | 'NJ' | 'NR' | 'NV' | 'OR' | 'SR' | 'SV' | 'ZZ'
      - `early_indication_service_component_string` string, nullable
      - `hera_covered` boolean, required — This indicates if the person left active duty within 367 days prior to the active duty
      - `hera_start_date` string, date-time, nullable — The date the servicemember entered active duty
      - `hera_end_date` string, date-time, nullable — The date the servicemember left active duty
      - `hera_service_component_code` string, nullable
      - `hera_service_component_string` string, nullable
      - `active_duty_indicator_code` string, nullable
      - `match_reason_code` string, nullable — Matching code for search
      - `scra_eligibility_type` string, nullable
  - `created_at` string, date-time, required — The datetime when the SCRA request was made

---

[API](https://skmtc.net/baselayer/apis/baselayer-api-service.md) · [All operations](https://skmtc.net/baselayer/apis/baselayer-api-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/baselayer/baselayer-api-service/revisions/0cc89938bc26/schema)