Skip to main content
Version: 1.7.3

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

FieldTypeDescription
VerificationRequestedObjectObject to identify the requested verification services opted for by the requester
    IsGIINBooleanIf true identifies that the requester opts for the verification
    IsOFACBooleanIf true identifies that the requester opts for the OFAC (Office of Foreign Assets Control) verification
    IsUSPSBooleanIf true identifies that the requester opts for the USPS Address verification
    IsNCOABooleanIf true identifies that the requester opts for the NCOA (National Change of Address) verification
    IsNONProfitSearchBooleanIf true identifies that the requester opts for the Tax Exempt organization verification
BusinessNmStringName of the business.
Size Range: ..75
TradeNmStringOptional Name under which the business operates
Size Range: ..75
EINStringEmployer Identification Number (EIN) of the requester
Size Range: 9-11
GIINStringGlobal Intermediary Identification Number (GIIN) of the requester
Size Range: 19
CountryCodeStringCountry 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"

USAddressobjectObject to identify the US address of the requester
    Address1StringAddress line 1 (street address or post office box of that locality)
Size Range: ..46
    Address2StringAddress line 2 (suite or apartment)
Size Range: ..46
    CityStringRequester's City
Size Range: ..50
    StateStringRequester'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"

    ZipCdStringRequester's zip code
Size Range: 5..10

Response Body

FieldTypeDescription
BusinessNmStringName of the business
TradeNmStringTrade name of the business
VerificationsObjectVerification details of the Requester
    GIINObjectRequester's GIIN verification details
        StatusStringReturns the status of whether the requester's given GIIN is valid
        GIINStringReturns the Global Intermediary Identification Number of the recipient
        CountryStringReturns the country code where the GIIN is officially registered
        MessageStringDetailed GIIN verification status message
    OFACObjectRecipient's OFAC verification details
        StatusStringReturns the status of whether the recipient is listed on U.S. government sanctions lists to prevent dealings with restricted or banned parties
        MessageStringDetailed OFAC verification status message
        Detailsobject[]Object to identify the detailed information on OFAC verification
            EntityidstringUnique ID of the OFAC entity
            SdnnamestringName of the SDN (Specially Designated National)
            SdntypestringType/category of the SDN
            Programstring[]List of sanction programs the entity is associated with
            TitlestringTitle associated with the entity
            CallsignstringVessel call sign, if applicable
            VesseltypestringType of vessel, if applicable
            TonnagestringVessel tonnage
            GrossregisteredtonnagestringVessel gross registered tonnage
            VesselflagstringFlag state of the vessel
            VesselownerstringOwner of the vessel
            RemarksstringAdditional sanctions info or notes
            MatchnumberConfidence score of the match (0.0 - 1.0)
            MatchednamestringName from OFAC matched to the business name
    USPSObjectrecipient's USPS Address verification details
        StatusStringReturns the status of whether the recipient's given address matches the USPS
        MessageStringDetailed USPS verification status message
        SuggestedAddressObjectObject to identify the USPS-recommended address based on the recipient's provided address
            Address1StringAddress line 1 (street address or post office box of that locality) is recommended by the USPS
            Address2StringAddress line 2 (Suite of Apartment) recommended by the USPS
            CityStringRecipient's city
            StateStringrecipient's State code
            ZipCdStringrecipient's Zip code
    NCOAObjectObject to identify the NCOA status of the recipient's given address
        StatusStringReturns the status of whether the recipient's given address has any forwarding address
        ForwardingAddressObjectObject to identify the forwarding address
            Address1StringAddress line 1 (street address or post office box of that locality)
            Address2StringAddress line 2 (Suite of Apartment)
            CityStringRecipient's city
            StateStringrecipient's State code
            ZipCdStringrecipient's Zip code
            messageStringDetailed 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

{
"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"
}
}
}