Ctrl+K

Create KYB Identity

post/api/identity-service/v1/identities

Create an identity with requested products. Requires User-Id header to associate the identity with the creating user.

Request Body

Body
One of
type string required
Identity type
Allowed value: individual
userId string required
The ID of the user
individual object
nameFirst string
First name of the individual
Match pattern: ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-]+$
nameLast string
Last name of the individual
Match pattern: ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-]+$
birthdate object
Birthdate
phoneNumber object
occupation string
Occupation category of the individual
Allowed values: Agriculture Art Dealer / Auctioneer / Import / Export Company Financial Services (Asset Mgmt., Bank, Broker Dealer, Commodities, Mutual Fund, Ins. Co) Casinos and Gambling Establishments Charity/NGO/Non-Profit/Foundation/Endowment Computer Programmer / Administrator / Software Engineer / IT or Software / Technology Company Crypto Services (ATM, Exchange, Lender, Coins/Token) Education / Teacher Extractive Industry (Oil, Gas, etc.) / Jewels / Gemstones / Precious Metals Family Office Film / TV / Entertainment (not adult) Government/State owned/Political Org. (i.e. Sovereign Wealth Fund) Healthcare Law Enforcement / Military / Protective Services Miner / Mining Pool Money Service Business Other Private Equity / Venture Capital Professional Service Providers (lawyers accountants etc.) Real estate brokers developers and appraisers Recreation / Hospitality Student / Unemployed / Retired Traders / Trading (High Frequency, Proprietary, Market Maker) Weapons Dealers
countryOfCitizenship
Country of citizenship (ISO 3166-1 alpha-3)
countryOfResidence
Country of residence (ISO 3166-1 alpha-3)
govIdCountryOfIssuance
Country where government ID was issued (ISO 3166-1 alpha-3)
address object
identificationNumber string
National identification number (e.g., SSN, passport number)
politicallyExposedPerson boolean
Whether the individual is a politically exposed person
requestedProducts array[object] required
List of requested bitgo products (can be empty for associated people)
name string required
Name of the permission
bitgoOrg string required
The entity granting the permission
finalizeSubmission boolean
Whether identity is ready for final submission and requirements validation
Default: false

201 Response

One of
type string required
Type of identity
Allowed value: individual
userId string required
The ID of the user
individual object required
nameFirst string
First name of the individual
Match pattern: ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-]+$
nameLast string
Last name of the individual
Match pattern: ^[A-Za-zÀ-ÿĀ-ſƀ-ɏ\s'\-]+$
birthdate object
Birthdate
phoneNumber object
occupation string
Occupation category of the individual
Allowed values: Agriculture Art Dealer / Auctioneer / Import / Export Company Financial Services (Asset Mgmt., Bank, Broker Dealer, Commodities, Mutual Fund, Ins. Co) Casinos and Gambling Establishments Charity/NGO/Non-Profit/Foundation/Endowment Computer Programmer / Administrator / Software Engineer / IT or Software / Technology Company Crypto Services (ATM, Exchange, Lender, Coins/Token) Education / Teacher Extractive Industry (Oil, Gas, etc.) / Jewels / Gemstones / Precious Metals Family Office Film / TV / Entertainment (not adult) Government/State owned/Political Org. (i.e. Sovereign Wealth Fund) Healthcare Law Enforcement / Military / Protective Services Miner / Mining Pool Money Service Business Other Private Equity / Venture Capital Professional Service Providers (lawyers accountants etc.) Real estate brokers developers and appraisers Recreation / Hospitality Student / Unemployed / Retired Traders / Trading (High Frequency, Proprietary, Market Maker) Weapons Dealers
countryOfCitizenship
Country of citizenship (ISO 3166-1 alpha-3)
countryOfResidence
Country of residence (ISO 3166-1 alpha-3)
govIdCountryOfIssuance
Country where government ID was issued (ISO 3166-1 alpha-3)
address object
identificationNumber string
National identification number (e.g., SSN, passport number)
politicallyExposedPerson boolean
Whether the individual is a politically exposed person
id string required
The unique ID of the created identity
ignoredFields array[string]
Ignored fields
requestedProducts array[object] required
List of products requested for this identity
id string required
Unique identifier for the requested permission
name string required
Name of the permission
bitgoOrg string required
The entity granting the permission
country
The country where the permission is being requested
subdivision string
The subdivision where the permission is being requested
Min length: >= 1 characters
Max length: <= 3 characters
status string required
Status of the requested permission
Allowed values: missingLocation missingEntityStructure missingRequirements readyForSubmission inReview approved rejected
requirements array[object] required
List of requirements related to the identity
id string required
Unique identifier for the requirement
kind string required
Type of requirement
Allowed values: businessInformation data document associatedPerson
name string required
Name of the requirement
status string required
Current status of the requirement
Allowed values: missing countExceeded submitted inReview verified
minRequired number
Minimum number required (for associated persons)
maxAllowed number
Maximum number allowed (for associated persons)
documents array[object]
List of documents associated with the identity
id string required
Internal ID for the document association
documentId string required
External document service ID
documentType string required
Type of document
Allowed values: governmentId commercialRegister articlesOfAssociation certificateOfIncorporation certificateOfTrust certificateOfIncumbency certificateOfIncumbencyOrShareRegister proofOfPrincipalPlaceOfBusiness activeTradeLicense resolutionToOpenBitgoUaeAccount resolutionToOpenBitgoSingaporeAccount proofOfAuthorizedSignatories memorandumOfAssociation memorandumAndArticlesOfAssociation bylawsOrOperatingAgreement operatingAgreement w8 w9 evidenceOfLegalStatus evidenceOfActiveStatus proofOfJfsaLicense proofOfGamingLicense organizationDocument partnershipAgreement articlesOfOrganization businessLicenseOrRegistration evidenceOfGovernmentOrStateOwnership secFilingsAsEvidenceOfPublicTradingStatus foundingTreatyOrEquivalent
status string required
Verification status
Allowed values: missing countExceeded submitted inReview verified
finalizeSubmission boolean required
Whether identity is ready for final submission and requirements validation

400 Response

error string required
Description of the error
details array[string]
Detailed error messages

401 Response

error string required
Description of the error
details array[string]
Detailed error messages

500 Response