KYB
KYB
The KYB (Know Your Business) endpoints allow you to submit business information and request verification through multiple sources such as GIIN, OFAC, USPS, NCOA, and Non-Profit databases. Once the request is made, the API returns the verification status for each selected source along with detailed messages.
For example, GIIN validation confirms FATCA registration, USPS may suggest address corrections, and the Non-Profit check verifies if the business is registered as a tax-exempt organization. These responses help ensure the legitimacy and compliance status of the business.
POST KYC/VerifyKYB Request Json
| Field | Type | Description |
|---|---|---|
| VerificationRequested | Object | Object to identify the requested verification services opted for by the requester |
| IsGIIN | Boolean | If true identifies that the requester opts for the 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 |
| IsNONProfitSearch | Boolean | If true identifies that the requester opts for the Tax Exempt organization verification |
| BusinessNm | String | Name of the business. Size Range: ..75 |
| TradeNm | String | Optional Name under which the business operates Size Range: ..75 |
| EIN | String | Employer Identification Number (EIN) of the requester Size Range: 9-11 |
| GIIN | String | Global Intermediary Identification Number (GIIN) of the requester Size Range: 19 |
| CountryCode | String | Country code where the GIIN is registered Size Range: 2 Allowed values"AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI" |
| USAddress | object | Object to identify the US address of the requester |
| 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 | Requester's City Size Range: ..50 |
| State | String | Requester'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 | Requester's zip code Size Range: 5..10 |
Response Body
| Field | Type | Description |
|---|---|---|
| BusinessNm | String | Name of the business |
| TradeNm | String | Trade name of the business |
| Verifications | Object | Verification details of the Requester |
| GIIN | Object | Requester's GIIN verification details |
| Status | String | Returns the status of whether the requester's given GIIN is valid |
| GIIN | String | Returns the Global Intermediary Identification Number of the recipient |
| Country | String | Returns the country code where the GIIN is officially registered |
| Message | String | Detailed GIIN 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 any 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": {
"IsGIIN": true,
"IsOFAC": true,
"IsUSPS": true,
"IsNCOA": true,
"IsNONProfitSearch": true
},
"BusinessNm": "DkartBusiness",
"TradeNm": null,
"EIN": "593-81-7572",
"GIIN": null,
"CountryCode": null,
"USAddress": {
"Address1": "3576 AIRPORT WAY",
"Address2": "UNIT 9",
"City": "FAIRBANKS",
"State": "AK",
"ZipCd": "99709"
}
}
Response JSON
- Response 1
- Response 2
{
"BusinessNm": null,
"TradeNm": null,
"verifications": {
"GIIN": {
"Status": "Valid",
"GIIN": "A1B2C3.00000.ME.840",
"Country": "CA",
"Message": "GIIN found and registered under FATCA"
},
"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"
}
}
}
{
"BusinessNm": null,
"TradeNm": null,
"verifications": {
"GIIN": {
"Status": "Invalid",
"GIIN": "A1B2C3.00000.ME.840",
"Country": "CA",
"Message": "No matching GIIN found or not registered under FATCA"
},
"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"
}
}
}