{"items":[{"type":"link","label":"SSN Name Match","link":"/apis/ssn-name-match","routeSlug":"/apis/ssn-name-match","content":{"contentType":"overview","seo":{"description":"SSN Name Match API by Melissa. Verify Social Security Number and name combinations for identity confirmation."},"meta":{"name":"SSN Name Match"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"ssn-name-match.json","url":"/_bundle/apis/ssn-name-match.json?download"},{"kind":"download","label":"ssn-name-match.yaml","url":"/_bundle/apis/ssn-name-match.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"csharpnewtonsoft","title":"C#+Newtonsoft","lang":"C#+Newtonsoft"},{"key":"java8","title":"Java8+Apache","lang":"Java8+Apache"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://namessn.melissadata.net/v4/web/SSN","description":"SSN Name Match Server"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"SSN Name Match","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/apis/ssn-name-match"}],"sectionId":"/apis/ssn-name-match"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/ssn-name-match-overview"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SSN Name Match Overview"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The SSN Name Match Cloud API determines if the Social Security Number is within the acceptable range, and matches against the First and Last Name. In addition, the Cloud API will also check if the SSN is flagged as deceased."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use SSN Name Match to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify SSN syntax is correct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify the SSN exists"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Match First and Last Name to the SSN"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Perform deceased suppression based upon SSN"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Documentation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.melissa.com/cloud-api/ssn-name-match/ssn-name-match-index.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SSN Name Match Documentation"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Useful Resources"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://github.com/MelissaData/MelissaCloudAPI-OpenAPI-Specification/blob/main/openapi/apis/ssn-name-match.yaml"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GitHub - SSN Name Match Open API Specification"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://releasenotes.melissa.com/cloud-api/ssn-name-match/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Release notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.melissa.com/cloud-api/ssn-name-match/result-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result codes"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product Page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.melissa.com/ssn-name-match"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://www.melissa.com/ssn-name-match"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Support Center"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.melissa.com/company/product-support"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://www.melissa.com/company/product-support"},"children":[]}]}]}]}]}],"sectionId":"/apis/ssn-name-match/section/ssn-name-match-overview"}]}]}},{"type":"link","label":"SSN Name Match Overview","link":"/apis/ssn-name-match/section/ssn-name-match-overview","routeSlug":"/apis/ssn-name-match/section/ssn-name-match-overview","content":null},{"type":"group","label":"Validate SSN and Name","link":"/apis/ssn-name-match/validate-ssn-and-name","routeSlug":"/apis/ssn-name-match/validate-ssn-and-name","items":[{"label":"Validate a SSN","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/ssn-name-match/validate-ssn-and-name/dolookupget","routeSlug":"/apis/ssn-name-match/validate-ssn-and-name/dolookupget","metadata":{"seo":{"title":"Validate a SSN","description":"Check if the Social Security Number is within the acceptable range, and match against the First and Last Name."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"dolookupGET","name":"Validate a SSN","isWebhook":false,"pointer":"/paths/~1doLookup/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validate a SSN","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Check if the Social Security Number is within the acceptable range, and match against the First and Last Name.\n"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"t","in":"query","schemaId":"schema_374","description":"Transmission Reference - Serves as a unique request identifier."},{"name":"id","in":"query","schemaId":"schema_375","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required. The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.melissa.com/melissa/license/license-information.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"License Key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" issued by Melissa."},"children":[]}]}]}],"required":true,"example":"{REPLACE-WITH-YOUR-LICENSE-KEY}"},{"name":"ssn","in":"query","schemaId":"schema_374","description":"Required. This is a string value containing the Social Security Number. All hyphens are ignored when submitting the SSN. We recommended using only numbers when submitting the SSN.","required":true,"example":"111222333"},{"name":"first","in":"query","schemaId":"schema_374","description":"Required. The given (first) name.","required":true,"example":"John"},{"name":"last","in":"query","schemaId":"schema_374","description":"Required. The family (last) name.","required":true,"example":"Doe"},{"name":"full","in":"query","schemaId":"schema_374","description":"Required. This field can contain a full name. We will parse and check Names only if the First Name and Last Name fields are left blank.","example":"John Doe"},{"name":"format","in":"query","schemaId":"schema_374","description":"Sets the format of the response.","example":"json"}],"pointer":"/paths/~1doLookup/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_376","description":"Format of the response.","required":true,"example":"application/json"},{"name":"Content-Type","in":"header","schemaId":"schema_377","description":"Format of the request.","required":true}],"pointer":"/paths/~1doLookup/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/doLookup","servers":[{"url":"https://namessn.melissadata.net/v4/web/SSN","description":"SSN Name Match Server"}],"parameters":{"path":[],"query":[{"name":"t","in":"query","schemaId":"schema_374"},{"name":"id","in":"query","required":true,"example":"{REPLACE-WITH-YOUR-LICENSE-KEY}","schemaId":"schema_375"},{"name":"ssn","in":"query","required":true,"example":"111222333","schemaId":"schema_374"},{"name":"first","in":"query","required":true,"example":"John","schemaId":"schema_374"},{"name":"last","in":"query","required":true,"example":"Doe","schemaId":"schema_374"},{"name":"full","in":"query","example":"John Doe","schemaId":"schema_374"},{"name":"format","in":"query","example":"json","schemaId":"schema_374"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json","schemaId":"schema_376"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_377"}],"cookie":[]},"security":[],"responseCodes":["200","400"],"pointer":"/doLookup","href":"validate-ssn-and-name/dolookupget","openApiOperationId":"dolookupGET","summary":"Validate a SSN"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://namessn.melissadata.net/v4/web/SSN","description":"SSN Name Match Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Response","exampleIds":["paths/~1doLookup/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Response","exampleIds":["paths/~1doLookup/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_378"}},"schemaId":"schema_378"}],"pointer":"/paths/~1doLookup/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Response","exampleIds":["paths/~1doLookup/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Response","exampleIds":["paths/~1doLookup/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_378","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_378"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/validate-ssn-and-name/dolookupget"}],"panels":[]}]},"httpPath":"/doLookup"},{"label":"Validate SSNs","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/ssn-name-match/validate-ssn-and-name/dolookuppost","routeSlug":"/apis/ssn-name-match/validate-ssn-and-name/dolookuppost","metadata":{"seo":{"title":"Validate SSNs","description":"Submit a batch request to check if the Social Security Numbers are within the acceptable range, and match against the First and Last Name."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"doLookupPOST","name":"Validate SSNs","isWebhook":false,"pointer":"/paths/~1doLookup/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validate SSNs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Submit a batch request to check if the Social Security Numbers are within the acceptable range, and match against the First and Last Name.\n"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_376","description":"Format of the response.","required":true,"example":"application/json"},{"name":"Content-Type","in":"header","schemaId":"schema_377","description":"Format of the request.","required":true}],"pointer":"/paths/~1doLookup/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Request","exampleIds":["paths/~1doLookup/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/Request","exampleIds":["paths/~1doLookup/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1doLookup/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/doLookup","servers":[{"url":"https://namessn.melissadata.net/v4/web/SSN","description":"SSN Name Match Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json","schemaId":"schema_376"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_377"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Request","exampleIds":["paths/~1doLookup/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400"],"pointer":"/doLookup","href":"validate-ssn-and-name/dolookuppost","openApiOperationId":"doLookupPOST","summary":"Validate SSNs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://namessn.melissadata.net/v4/web/SSN","description":"SSN Name Match Server"}],"schemaId":"components/schemas/Request","exampleIds":["paths/~1doLookup/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Request","exampleIds":["paths/~1doLookup/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Response","exampleIds":["paths/~1doLookup/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Response","exampleIds":["paths/~1doLookup/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_378"}},"schemaId":"schema_378"}],"pointer":"/paths/~1doLookup/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Response","exampleIds":["paths/~1doLookup/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Response","exampleIds":["paths/~1doLookup/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_378","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_378"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/validate-ssn-and-name/dolookuppost"}],"panels":[]}]},"httpPath":"/doLookup"}],"content":{"contentType":"group","meta":{"name":"Validate SSN and Name"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validate SSN and Name","showPageActions":true},{"nodeType":"markdoc","content":"Use Validate SSN and Name endpoint to check if the Social Security Number is within the acceptable range, and match against the First and Last Name."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/doLookup","summary":"Validate a SSN","prefix":{"name":"get","color":"get"},"badges":[],"link":"/validate-ssn-and-name/dolookupget","deprecated":false},{"title":"/doLookup","summary":"Validate SSNs","prefix":{"name":"post","color":"post"},"badges":[],"link":"/validate-ssn-and-name/dolookuppost","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Request":{"id":"components/schemas/Request","kind":"json-schema","title":"Request","data":{"type":"object","required":["CustomerId","Records"],"properties":{"TransmissionReference":{"type":"string","description":"Serves as a unique request identifier."},"CustomerId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required. The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.melissa.com/melissa/license/license-information.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"License Key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" issued by Melissa."},"children":[]}]}]}]},"Records":{"type":"array","xml":{"wrapped":true},"minItems":1,"maxItems":100,"items":{"$ref":"#/components/schemas/RequestRecord"}}},"additionalProperties":false}},"components/schemas/RequestRecord":{"id":"components/schemas/RequestRecord","kind":"json-schema","title":"RequestRecord","data":{"type":"object","xml":{"name":"RequestRecord"},"required":["SSN"],"properties":{"RecordID":{"type":"string","description":"This is a string value containing a unique identifier for the current record. Use this to match the record submitted with the record returned. It will return what is inputted."},"SSN":{"type":"string","description":"Required. This is a string value containing the Social Security Number. All hyphens are ignored when submitting the SSN. We recommended using only numbers when submitting the SSN."},"FirstName":{"type":"string","description":"Required. The given (first) name."},"LastName":{"type":"string","description":"Required. The family (last) name."},"FullName":{"type":"string","description":"Required. This field can contain a full name. We will parse and check Names only if the First Name and Last Name fields are left blank."}},"additionalProperties":false}},"components/schemas/Response":{"id":"components/schemas/Response","kind":"json-schema","title":"Response","data":{"type":"object","xml":{"name":"Response"},"properties":{"TransmissionResults":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists error codes from any errors caused by the most recent request as a whole. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.melissa.com/cloud-api/ssn-name-match/result-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SSN Name Match Result Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"TransmissionReference":{"type":"string","description":"A pass-through of the input TransmissionReference field."},"Version":{"type":"string","description":"The current service version number."},"TotalRecords":{"type":"string","description":"Total number of records."},"Records":{"type":"array","xml":{"wrapped":true},"items":{"$ref":"#/components/schemas/ResponseRecord"}}}}},"components/schemas/ResponseRecord":{"id":"components/schemas/ResponseRecord","kind":"json-schema","title":"ResponseRecord","data":{"type":"object","xml":{"name":"ResponseRecord"},"properties":{"RecordID":{"type":"string","description":"The record ID."},"SSN":{"type":"string","description":"The Social Security Number submitted for validation."},"IssuingState":{"type":"string","description":"The issuing state calculated by using the SSN Area Number (first 3 digits of the SSN)."},"Results":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma delimited status, error codes, and change codes for the record. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.melissa.com/cloud-api/ssn-name-match/result-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SSN Name Match Result Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"ResultsFromDataSource":{"type":"string","description":"Comma delimited status, error codes, and change codes from the Data Source."}}}},"schema_374":{"kind":"json-schema","data":{"type":"string"},"id":"schema_374"},"schema_375":{"kind":"json-schema","data":{"format":"password"},"id":"schema_375"},"schema_376":{"kind":"json-schema","data":{"type":"string","enum":["application/json","*/*"]},"id":"schema_376"},"schema_377":{"kind":"json-schema","data":{"type":"string","enum":["application/json","application/xml"]},"id":"schema_377"},"schema_378":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","description":"The type of error that occurred."},"title":{"type":"string","description":"A short summary of the error."},"status":{"type":"integer","description":"The HTTP status code for the error."},"errors":{"type":"object","properties":{"$.<PropertyName>":{"type":"array","description":"A detailed message about the error.","items":{"type":"string"}}}},"traceId":{"type":"string","description":"A unique identifier for the request, useful for debugging."}}},"id":"schema_378"}},"exampleStore":{"paths/~1doLookup/get/responses/200/content/application~1json/example":{"value":{"TransmissionResults":"","TransmissionReference":"","Version":"6.2.0.1028","TotalRecords":"1","Records":[{"RecordID\"":"1","SSN\"":"111222333","IssuingState\"":"New York","Results\"":"SN07","ResultsFromDataSource":"TU01"}]},"id":"paths/~1doLookup/get/responses/200/content/application~1json/example"},"paths/~1doLookup/post/requestBody/content/application~1json/example":{"value":{"TransmissionReference":"test","CustomerId":"{REPLACE-WITH-YOUR-LICENSE-KEY}","Records":[{"FirstName":"John","FullName":"John Doe","LastName":"Doe","RecordID":"1","SSN":"111222333"}]},"id":"paths/~1doLookup/post/requestBody/content/application~1json/example"},"paths/~1doLookup/post/responses/200/content/application~1json/example":{"value":{"TransmissionResults":"","TransmissionReference":"","Version":"6.2.0.1028","TotalRecords":"1","Records":[{"RecordID\"":"1","SSN\"":"111222333","IssuingState\"":"New York","Results\"":"SN07","ResultsFromDataSource":"TU01"}]},"id":"paths/~1doLookup/post/responses/200/content/application~1json/example"}},"securitySchemeStore":{},"servers":[{"url":"https://namessn.melissadata.net/v4/web/SSN","description":"SSN Name Match Server"}],"specType":"openapi"},"options":{"hideInfoMetadata":true,"hideSchemaTitles":true,"codeSamples":{"skipOptionalParameters":true,"languages":[{"lang":"curl"},{"lang":"C#"},{"lang":"Python"},{"lang":"Java"},{"lang":"JavaScript"},{"lang":"Node.js"},{"lang":"PHP"},{"lang":"Go"},{"lang":"Ruby"},{"lang":"R"},{"lang":"C#+Newtonsoft"},{"lang":"Java8+Apache"},{"lang":"Payload"}]},"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/ssn-name-match.json?download"},{"url":"/_bundle/apis/ssn-name-match.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"SSN Name Match","description":"## SSN Name Match Overview ##\nThe SSN Name Match Cloud API determines if the Social Security Number is within the acceptable range, and matches against the First and Last Name. In addition, the Cloud API will also check if the SSN is flagged as deceased.\n\nYou can use SSN Name Match to:\n- Verify SSN syntax is correct\n- Verify the SSN exists\n- Match First and Last Name to the SSN\n- Perform deceased suppression based upon SSN\n\n**Documentation**\n* [SSN Name Match Documentation](https://docs.melissa.com/cloud-api/ssn-name-match/ssn-name-match-index.html)\n\n**Useful Resources**\n* [GitHub - SSN Name Match Open API Specification](https://github.com/MelissaData/MelissaCloudAPI-OpenAPI-Specification/blob/main/openapi/apis/ssn-name-match.yaml)\n* [Release notes](https://releasenotes.melissa.com/cloud-api/ssn-name-match/)\n* [Result codes](https://docs.melissa.com/cloud-api/ssn-name-match/result-codes.html)\n\n**Product Page**\n\n[https://www.melissa.com/ssn-name-match](https://www.melissa.com/ssn-name-match)\n\n**Support Center**\n\n[https://www.melissa.com/company/product-support](https://www.melissa.com/company/product-support)\n"}},"baseSlug":"/apis/ssn-name-match","routesMapping":{}}