KYC
KYC
This endpoint can be used to complete identity verification for your recipients, vendors, or individuals for whom you file tax forms. By submitting a request, you can validate an individual’s identity through multiple trusted sources. The API returns detailed verification results, including status and any relevant messages for each chosen verification source.
- DMF (Death Master File): Validates the individual’s identity against the Death Master File to confirm if they are listed as deceased.
- OFAC (Office of Foreign Assets Control): Cross-references the individual’s details with the OFAC list to ensure they are not subject to U.S. sanctions.
- USPS (United States Postal Service) Address Validation: Confirms the recipient's address by comparing it to the official USPS database for accuracy.
- NCOA (National Change of Address): Verifies any recent address changes by checking the recipient’s address against the National Change of Address database.
POST KYC/VerifyKYC Request Json
| Field | Type | Description |
|---|---|---|
| VerificationRequested | Object | Object to identify the requested verification services opted by the requester |
| IsDMF | Boolean | If true identifies that the requester opts for the DMF (Death Master File) verification |
| IsOFAC | Boolean | If true identifies that the requester opts for the OFAC (Office of Foreign Assets Control) verification |
| IsUSPS | Boolean | If true identifies that the requester opts for the USPS Address verification |
| IsNCOA | Boolean | If true identifies that the requester opts for the NCOA (National Change of Address) verification |
| FirstNm | String | First Name of the recipient Size Range: ..20 |
| MiddleNm | String | Optional Middle Name of the recipient Size Range: ..20 |
| LastNm | String | Last Name of the recipient Size Range: ..20 |
| Suffix | String | Optional Suffix of the recipient Allowed values"Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII" |
| DOB | String | Date of Birth of the recipient |
| TINType | String | Specify the TIN type of the Recipient. |
| TIN | String | Enter the nine-digit taxpayer identification number. Size Range: 9-11 |
| USAddress | Object | Object to identify the US address of the recipient |
| Address1 | String | Address line 1 (street address or post office box of that locality) Size Range: ..46 |
| Address2 | String | Address line 2 (suite or apartment) Size Range: ..46 |
| City | String | Recipient's City Size Range: ..50 |
| State | String | Recipient's State code. Refer static values. Size Range: 2 Allowed values"AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP" |
| ZipCd | String | Recipient's zip code Size Range: 5..10 |
Response Body
| Field | Type | Description |
|---|---|---|
| FirstNm | String | First Name of the Recipient |
| MiddleNm | String | Middle Name of the Recipient |
| LastNm | String | Last Name of the Recipient |
| Suffix | String | Suffix of the Recipient |
| Verifications | Object | Verification details of the Recipient |
| DMF | Object | recipient's Death Master File verification details |
| Status | String | Returns the status of whether the recipient is listed as deceased in the comprehensive database maintained by the Social Security Administration |
| Message | String | Detailed DMF verification status message |
| OFAC | Object | recipient's OFAC verification details |
| Status | String | Returns the status of whether the recipient is listed on U.S. government sanctions lists to prevent dealings with restricted or banned parties |
| Message | String | Detailed OFAC verification status message |
| Details | Object[] | Object to identify the detailed information on OFAC verification |
| Entityid | string | Unique ID of the OFAC entity |
| Sdnname | string | Name of the SDN (Specially Designated National) |
| Sdntype | string | Type/category of the SDN |
| Program | string[] | List of sanction programs the entity is associated with |
| Title | string | Title associated with the entity |
| Callsign | string | Vessel call sign if applicable |
| Vesseltype | string | Type of vessel if applicable |
| Tonnage | string | Vessel tonnage |
| Grossregisteredtonnage | string | Vessel gross registered tonnage |
| Vesselflag | string | Flag state of the vessel |
| Vesselowner | string | Owner of the vessel |
| Remarks | string | Additional sanctions info or notes |
| Match | number | Confidence score of the match (0.0 - 1.0) |
| Matchedname | string | Name from OFAC matched to the business name |
| USPS | Object | recipient's USPS Address verification details |
| Status | String | Returns the status of whether the recipient's given address matches the USPS |
| Message | String | Detailed USPS verification status message |
| SuggestedAddress | Object | Object to identify the USPS-recommended address based on the recipient's provided address |
| Address1 | String | Address line 1 (street address or post office box of that locality) is recommended by the USPS |
| Address2 | String | Address line 2 (Suite of Apartment) recommended by the USPS |
| City | String | Recipient's city |
| State | String | recipient's State code |
| ZipCd | String | recipient's Zip code |
| NCOA | Object | Object to identify the NCOA status of the recipient's given address |
| Status | String | Returns the status of whether the recipient's given address has a forwarding address |
| ForwardingAddress | Object | Object to identify the forwarding address |
| Address1 | String | Address line 1 (street address or post office box of that locality) |
| Address2 | String | Address line 2 (Suite of Apartment) |
| City | String | Recipient's city |
| State | String | recipient's State code |
| ZipCd | String | recipient's Zip code |
| message | String | Detailed NCOA verification status message |
Request JSON
{
"VerificationRequested": {
"IsDMF": true,
"IsOFAC": true,
"IsUSPS": true,
"IsNCOA": true
},
"FirstNm": "Shawn",
"MiddleNm": null,
"LastNm": "Williams",
"Suffix": null,
"DOB": null,
"TINType": "SSN",
"TIN": "593-81-7572",
"USAddress": {
"Address1": "3576 AIRPORT WAY",
"Address2": "UNIT 9",
"City": "FAIRBANKS",
"State": "AK",
"ZipCd": "99709"
}
}
Response JSON
- Response 1
- Response 2
{
"FirstNm": "Shawn",
"MiddleNm": null,
"LastNm": "Williams",
"Suffix": null,
"Verifications": {
"DMF": {
"Status": "No Match",
"Message": "No match found in the Death Master File"
},
"OFAC": {
"Status": "No Match",
"Message": "No matches found in OFAC sanctions list",
"Details": null
},
"USPS": {
"Status": "Suggestion",
"Message": "The USPS has made some suggestions to the provided address.",
"SuggestedAddress": {
"Address1": "3576 AIRPORT WAY",
"Address2": "UNIT 9",
"City": "FAIRBANKS",
"State": "AK",
"ZipCd": "99709"
}
},
"NCOA": {
"Status": "No Match",
"ForwardingAddress": null,
"message": "NCOA not registered"
}
}
}
{
"FirstNm": "Shawn",
"MiddleNm": null,
"LastNm": "Williams",
"Suffix": null,
"Verifications": {
"DMF": {
"Status": "Match",
"Message": "Match found in the Death Master File"
},
"OFAC": {
"Status": "Match",
"Message": "Name appears on the OFAC sanctions list. Further action required",
"Details": null
},
"USPS": {
"Status": "Invalid",
"Message": "Invalid or undeliverable address",
"UpdatedAddress": null
},
"NCOA": {
"Status": true,
"ForwardingAddress": {
"Address1": "123 NEW ADDRESS LN",
"Address2": null,
"City": "ANCHORAGE",
"State": "AK",
"ZipCd": "99501"
},
"message": "Address registered for NCOA"
}
}
}