Scra Search
curl --request POST \
--url https://api.baselayer.com/scra/searches \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"first_name": "<string>",
"last_name": "<string>",
"ssn": "<string>",
"parse_permutate_options": {
"keep_original": true,
"first_name_remove_list": "<string>",
"last_name_remove_list": "<string>",
"force_hyphen": true,
"parse_prefix": true,
"parse_suffix": true,
"max_permutation_count": 50,
"merge_name_parts": true,
"mixed_case_split": true,
"toggle_middle_name": true,
"toggle_primary_name": true,
"transpose": true,
"validate_permutation_count": true,
"remove_nobiliary_participle": true
},
"certificate": false,
"reference_id": "Search1234",
"middle_name": "<string>",
"birth_date": "2023-12-25",
"date_of_interest": "2026-08-31"
}
'import requests
url = "https://api.baselayer.com/scra/searches"
payload = {
"first_name": "<string>",
"last_name": "<string>",
"ssn": "<string>",
"parse_permutate_options": {
"keep_original": True,
"first_name_remove_list": "<string>",
"last_name_remove_list": "<string>",
"force_hyphen": True,
"parse_prefix": True,
"parse_suffix": True,
"max_permutation_count": 50,
"merge_name_parts": True,
"mixed_case_split": True,
"toggle_middle_name": True,
"toggle_primary_name": True,
"transpose": True,
"validate_permutation_count": True,
"remove_nobiliary_participle": True
},
"certificate": False,
"reference_id": "Search1234",
"middle_name": "<string>",
"birth_date": "2023-12-25",
"date_of_interest": "2026-08-31"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
first_name: '<string>',
last_name: '<string>',
ssn: '<string>',
parse_permutate_options: {
keep_original: true,
first_name_remove_list: '<string>',
last_name_remove_list: '<string>',
force_hyphen: true,
parse_prefix: true,
parse_suffix: true,
max_permutation_count: 50,
merge_name_parts: true,
mixed_case_split: true,
toggle_middle_name: true,
toggle_primary_name: true,
transpose: true,
validate_permutation_count: true,
remove_nobiliary_participle: true
},
certificate: false,
reference_id: 'Search1234',
middle_name: '<string>',
birth_date: '2023-12-25',
date_of_interest: '2026-08-31'
})
};
fetch('https://api.baselayer.com/scra/searches', 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.baselayer.com/scra/searches",
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([
'first_name' => '<string>',
'last_name' => '<string>',
'ssn' => '<string>',
'parse_permutate_options' => [
'keep_original' => true,
'first_name_remove_list' => '<string>',
'last_name_remove_list' => '<string>',
'force_hyphen' => true,
'parse_prefix' => true,
'parse_suffix' => true,
'max_permutation_count' => 50,
'merge_name_parts' => true,
'mixed_case_split' => true,
'toggle_middle_name' => true,
'toggle_primary_name' => true,
'transpose' => true,
'validate_permutation_count' => true,
'remove_nobiliary_participle' => true
],
'certificate' => false,
'reference_id' => 'Search1234',
'middle_name' => '<string>',
'birth_date' => '2023-12-25',
'date_of_interest' => '2026-08-31'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.baselayer.com/scra/searches"
payload := strings.NewReader("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"ssn\": \"<string>\",\n \"parse_permutate_options\": {\n \"keep_original\": true,\n \"first_name_remove_list\": \"<string>\",\n \"last_name_remove_list\": \"<string>\",\n \"force_hyphen\": true,\n \"parse_prefix\": true,\n \"parse_suffix\": true,\n \"max_permutation_count\": 50,\n \"merge_name_parts\": true,\n \"mixed_case_split\": true,\n \"toggle_middle_name\": true,\n \"toggle_primary_name\": true,\n \"transpose\": true,\n \"validate_permutation_count\": true,\n \"remove_nobiliary_participle\": true\n },\n \"certificate\": false,\n \"reference_id\": \"Search1234\",\n \"middle_name\": \"<string>\",\n \"birth_date\": \"2023-12-25\",\n \"date_of_interest\": \"2026-08-31\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.baselayer.com/scra/searches")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"ssn\": \"<string>\",\n \"parse_permutate_options\": {\n \"keep_original\": true,\n \"first_name_remove_list\": \"<string>\",\n \"last_name_remove_list\": \"<string>\",\n \"force_hyphen\": true,\n \"parse_prefix\": true,\n \"parse_suffix\": true,\n \"max_permutation_count\": 50,\n \"merge_name_parts\": true,\n \"mixed_case_split\": true,\n \"toggle_middle_name\": true,\n \"toggle_primary_name\": true,\n \"transpose\": true,\n \"validate_permutation_count\": true,\n \"remove_nobiliary_participle\": true\n },\n \"certificate\": false,\n \"reference_id\": \"Search1234\",\n \"middle_name\": \"<string>\",\n \"birth_date\": \"2023-12-25\",\n \"date_of_interest\": \"2026-08-31\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.baselayer.com/scra/searches")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"ssn\": \"<string>\",\n \"parse_permutate_options\": {\n \"keep_original\": true,\n \"first_name_remove_list\": \"<string>\",\n \"last_name_remove_list\": \"<string>\",\n \"force_hyphen\": true,\n \"parse_prefix\": true,\n \"parse_suffix\": true,\n \"max_permutation_count\": 50,\n \"merge_name_parts\": true,\n \"mixed_case_split\": true,\n \"toggle_middle_name\": true,\n \"toggle_primary_name\": true,\n \"transpose\": true,\n \"validate_permutation_count\": true,\n \"remove_nobiliary_participle\": true\n },\n \"certificate\": false,\n \"reference_id\": \"Search1234\",\n \"middle_name\": \"<string>\",\n \"birth_date\": \"2023-12-25\",\n \"date_of_interest\": \"2026-08-31\"\n}"
response = http.request(request)
puts response.read_body{
"covered": true,
"created_at": "2023-11-07T05:31:56Z",
"reference_id": "Search1234",
"results": [
{
"person_request": {
"pn_id": "<string>",
"pn_id_confirmation": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"middle_name": "<string>",
"date_of_birth": "2023-11-07T05:31:56Z",
"active_duty_date": "2023-11-07T05:31:56Z",
"cadency_name": "<string>",
"batch_id": "<string>"
},
"eligibility": {
"covered": true,
"active_duty_covered": true,
"early_indication_covered": true,
"hera_covered": true,
"transaction_id": "<string>",
"content": "<string>",
"date_of_interest": "2023-11-07T05:31:56Z",
"active_duty_start_date": "2023-11-07T05:31:56Z",
"active_duty_end_date": "2023-11-07T05:31:56Z",
"active_duty_service_component_code": "AG",
"active_duty_service_component_string": "<string>",
"early_indication_start_date": "2023-11-07T05:31:56Z",
"early_indication_end_date": "2023-11-07T05:31:56Z",
"early_indication_service_component_code": "AG",
"early_indication_service_component_string": "<string>",
"hera_start_date": "2023-11-07T05:31:56Z",
"hera_end_date": "2023-11-07T05:31:56Z",
"hera_service_component_code": "<string>",
"hera_service_component_string": "<string>",
"active_duty_indicator_code": "<string>",
"match_reason_code": "<string>",
"scra_eligibility_type": "<string>"
},
"id": "<string>"
}
]
}SCRA & MLA
Scra Search
POST
/
scra
/
searches
Scra Search
curl --request POST \
--url https://api.baselayer.com/scra/searches \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"first_name": "<string>",
"last_name": "<string>",
"ssn": "<string>",
"parse_permutate_options": {
"keep_original": true,
"first_name_remove_list": "<string>",
"last_name_remove_list": "<string>",
"force_hyphen": true,
"parse_prefix": true,
"parse_suffix": true,
"max_permutation_count": 50,
"merge_name_parts": true,
"mixed_case_split": true,
"toggle_middle_name": true,
"toggle_primary_name": true,
"transpose": true,
"validate_permutation_count": true,
"remove_nobiliary_participle": true
},
"certificate": false,
"reference_id": "Search1234",
"middle_name": "<string>",
"birth_date": "2023-12-25",
"date_of_interest": "2026-08-31"
}
'import requests
url = "https://api.baselayer.com/scra/searches"
payload = {
"first_name": "<string>",
"last_name": "<string>",
"ssn": "<string>",
"parse_permutate_options": {
"keep_original": True,
"first_name_remove_list": "<string>",
"last_name_remove_list": "<string>",
"force_hyphen": True,
"parse_prefix": True,
"parse_suffix": True,
"max_permutation_count": 50,
"merge_name_parts": True,
"mixed_case_split": True,
"toggle_middle_name": True,
"toggle_primary_name": True,
"transpose": True,
"validate_permutation_count": True,
"remove_nobiliary_participle": True
},
"certificate": False,
"reference_id": "Search1234",
"middle_name": "<string>",
"birth_date": "2023-12-25",
"date_of_interest": "2026-08-31"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
first_name: '<string>',
last_name: '<string>',
ssn: '<string>',
parse_permutate_options: {
keep_original: true,
first_name_remove_list: '<string>',
last_name_remove_list: '<string>',
force_hyphen: true,
parse_prefix: true,
parse_suffix: true,
max_permutation_count: 50,
merge_name_parts: true,
mixed_case_split: true,
toggle_middle_name: true,
toggle_primary_name: true,
transpose: true,
validate_permutation_count: true,
remove_nobiliary_participle: true
},
certificate: false,
reference_id: 'Search1234',
middle_name: '<string>',
birth_date: '2023-12-25',
date_of_interest: '2026-08-31'
})
};
fetch('https://api.baselayer.com/scra/searches', 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.baselayer.com/scra/searches",
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([
'first_name' => '<string>',
'last_name' => '<string>',
'ssn' => '<string>',
'parse_permutate_options' => [
'keep_original' => true,
'first_name_remove_list' => '<string>',
'last_name_remove_list' => '<string>',
'force_hyphen' => true,
'parse_prefix' => true,
'parse_suffix' => true,
'max_permutation_count' => 50,
'merge_name_parts' => true,
'mixed_case_split' => true,
'toggle_middle_name' => true,
'toggle_primary_name' => true,
'transpose' => true,
'validate_permutation_count' => true,
'remove_nobiliary_participle' => true
],
'certificate' => false,
'reference_id' => 'Search1234',
'middle_name' => '<string>',
'birth_date' => '2023-12-25',
'date_of_interest' => '2026-08-31'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.baselayer.com/scra/searches"
payload := strings.NewReader("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"ssn\": \"<string>\",\n \"parse_permutate_options\": {\n \"keep_original\": true,\n \"first_name_remove_list\": \"<string>\",\n \"last_name_remove_list\": \"<string>\",\n \"force_hyphen\": true,\n \"parse_prefix\": true,\n \"parse_suffix\": true,\n \"max_permutation_count\": 50,\n \"merge_name_parts\": true,\n \"mixed_case_split\": true,\n \"toggle_middle_name\": true,\n \"toggle_primary_name\": true,\n \"transpose\": true,\n \"validate_permutation_count\": true,\n \"remove_nobiliary_participle\": true\n },\n \"certificate\": false,\n \"reference_id\": \"Search1234\",\n \"middle_name\": \"<string>\",\n \"birth_date\": \"2023-12-25\",\n \"date_of_interest\": \"2026-08-31\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.baselayer.com/scra/searches")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"ssn\": \"<string>\",\n \"parse_permutate_options\": {\n \"keep_original\": true,\n \"first_name_remove_list\": \"<string>\",\n \"last_name_remove_list\": \"<string>\",\n \"force_hyphen\": true,\n \"parse_prefix\": true,\n \"parse_suffix\": true,\n \"max_permutation_count\": 50,\n \"merge_name_parts\": true,\n \"mixed_case_split\": true,\n \"toggle_middle_name\": true,\n \"toggle_primary_name\": true,\n \"transpose\": true,\n \"validate_permutation_count\": true,\n \"remove_nobiliary_participle\": true\n },\n \"certificate\": false,\n \"reference_id\": \"Search1234\",\n \"middle_name\": \"<string>\",\n \"birth_date\": \"2023-12-25\",\n \"date_of_interest\": \"2026-08-31\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.baselayer.com/scra/searches")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"ssn\": \"<string>\",\n \"parse_permutate_options\": {\n \"keep_original\": true,\n \"first_name_remove_list\": \"<string>\",\n \"last_name_remove_list\": \"<string>\",\n \"force_hyphen\": true,\n \"parse_prefix\": true,\n \"parse_suffix\": true,\n \"max_permutation_count\": 50,\n \"merge_name_parts\": true,\n \"mixed_case_split\": true,\n \"toggle_middle_name\": true,\n \"toggle_primary_name\": true,\n \"transpose\": true,\n \"validate_permutation_count\": true,\n \"remove_nobiliary_participle\": true\n },\n \"certificate\": false,\n \"reference_id\": \"Search1234\",\n \"middle_name\": \"<string>\",\n \"birth_date\": \"2023-12-25\",\n \"date_of_interest\": \"2026-08-31\"\n}"
response = http.request(request)
puts response.read_body{
"covered": true,
"created_at": "2023-11-07T05:31:56Z",
"reference_id": "Search1234",
"results": [
{
"person_request": {
"pn_id": "<string>",
"pn_id_confirmation": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"middle_name": "<string>",
"date_of_birth": "2023-11-07T05:31:56Z",
"active_duty_date": "2023-11-07T05:31:56Z",
"cadency_name": "<string>",
"batch_id": "<string>"
},
"eligibility": {
"covered": true,
"active_duty_covered": true,
"early_indication_covered": true,
"hera_covered": true,
"transaction_id": "<string>",
"content": "<string>",
"date_of_interest": "2023-11-07T05:31:56Z",
"active_duty_start_date": "2023-11-07T05:31:56Z",
"active_duty_end_date": "2023-11-07T05:31:56Z",
"active_duty_service_component_code": "AG",
"active_duty_service_component_string": "<string>",
"early_indication_start_date": "2023-11-07T05:31:56Z",
"early_indication_end_date": "2023-11-07T05:31:56Z",
"early_indication_service_component_code": "AG",
"early_indication_service_component_string": "<string>",
"hera_start_date": "2023-11-07T05:31:56Z",
"hera_end_date": "2023-11-07T05:31:56Z",
"hera_service_component_code": "<string>",
"hera_service_component_string": "<string>",
"active_duty_indicator_code": "<string>",
"match_reason_code": "<string>",
"scra_eligibility_type": "<string>"
},
"id": "<string>"
}
]
}Authorizations
Body
application/jsonapplication/vnd.baselayer.v1+json
The first name of the person of interest
Maximum string length:
20The last name of the person of interest
Pattern:
^[A-Za-z \-\'\s]*$The social security number of the person of interest
Name parsing and permutation settings
Show child attributes
Show child attributes
Indicates if DMDC certificate should be included in response. Defaults to False
An optional reference ID to associate with the search request.
Maximum string length:
128Example:
"Search1234"
The middle name of the person of interest
The birth date of the person of interest. No dates before 1900-01-01 or in the future
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
Response
This indicates if any of the searches performed contained SCRA coverage
The datetime when the SCRA request was made
The reference ID associated with the search.
Example:
"Search1234"
List of SCRA search results
Show child attributes
Show child attributes