Upon successful customer creation, a hosted KYC link requesting the required information to fill in will be generated. This may be distributed to your end-user for completion, or it can be completed on the customer’s behalf by your team.
Current verification issues blocking customer approval. Only present for customers in NEEDS_ADDITIONAL_INFORMATION, UNDER_REVIEW, or REJECTED status.
Show child attributes
Example:
[ { "code": "DOCUMENT_MISSING_BACK", "message": "Please upload clear photos of both the front and back of your ID.", "timestamp": "2023-10-01T12:00:00Z" } ]
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Fern API Documentation","colors":{"primary":"#075E3F"},"styling":{"eyebrows":"breadcrumbs"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"fern-e3ce17d5","hasAudioNarration":false,"actualSubdomain":"fern-e3ce17d5","customDomains":["docs.fernhq.com"],"gitSource":{"type":"github","owner":"tephralabs","repo":"fern-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6ae9412232eef4370465cead:success","clientVersion":"0.0.4160","searchFilterCounts":[{"language":"default","tag":"Documentation","count":32},{"language":"default","tag":"API Reference","count":26},{"language":"default","tag":"Customer Verification","count":18},{"language":"default","tag":"Webhooks","count":11},{"language":"default","tag":"Guides","count":11},{"language":"default","tag":"Payment Accounts","count":9},{"language":"default","tag":"Transactions","count":6},{"language":"default","tag":"Money Movement","count":5},{"language":"default","tag":"Automation Rules","count":5},{"language":"default","tag":"Getting Started","count":4}]},"assistantConfig":{"enableAskAiButton":true,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/customers/create-customer","slug":"/api-reference/customers/create-customer","pageMetadata":{"title":"Create customer","description":"Upon successful customer creation, a hosted KYC link requesting the required information to fill in will be generated. This may be distributed to your end-user for completion, or it can be completed on the customer's behalf by your team. ","deprecated":null,"version":null,"openapi":"https://api.fernhq.com/json post /customers","href":"/api-reference/customers/create-customer","autogeneratedByOpenApi":true,"hidden":false},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Upon successful customer creation, a hosted KYC link requesting the required information to fill in will be generated. This may be distributed to your end-user for completion, or it can be completed on the customer’s behalf by your team.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create customer","description":"Upon successful customer creation, a hosted KYC link requesting the required information to fill in will be generated. This may be distributed to your end-user for completion, or it can be completed on the customer's behalf by your team. ","deprecated":null,"version":null,"openapi":"https://api.fernhq.com/json post /customers","href":"/api-reference/customers/create-customer","autogeneratedByOpenApi":true,"hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"createCustomer","summary":"Create customer","tags":["Customers"],"description":"Upon successful customer creation, a hosted KYC link requesting the required information to fill in will be generated. This may be distributed to your end-user for completion, or it can be completed on the customer's behalf by your team. ","requestBody":"960c6833-aa07-4e7e-8a4d-dd2f83858816","responses":{"201":"e1d0dffe-09f6-48ca-9b0a-0ece1e7da386","400":"f51dcf7b-497e-47e4-83d1-971a24156fa6","401":"281d89e3-1ca7-47eb-8e29-d251e1cbfc50","403":"a48087f2-3c30-482e-8e30-52917bbf3ba1","404":"6a20af03-0fde-4ebb-9eae-38e88c00e53e","500":"4816dbbe-1c12-4e04-bc2b-e836a36cb59b"},"method":"post","type":"path","servers":["2d601e0e-cd6f-46b1-99a3-ec1f1dba16f1"],"security":["94145c0a-bd1e-40cc-98ba-b1d672fbe835"],"path":"/customers","baseUrlOptions":["https://api.fernhq.com"],"title":"Create customer","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"customerType":{"enum":["INDIVIDUAL","BUSINESS"],"type":"string","title":"Customer Type Enums","description":"The type of customer - either individual or business","isRequired":true,"uniqueKey":"customerType","typeLabel":"enum\u003cstring>"},"email":{"format":"email","type":"string","description":"Email of the customer","example":"john.doe@example.com","isRequired":true,"uniqueKey":"email","typeLabel":"string\u003cemail>"},"firstName":{"type":"string","description":"First name of the customer","example":"John","uniqueKey":"firstName","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the customer","example":"Doe","uniqueKey":"lastName","typeLabel":"string"},"businessName":{"type":"string","description":"Name of the business","example":"John Doe Inc.","uniqueKey":"businessName","typeLabel":"string"},"kycData":{"type":"object","properties":{"legalFirstName":{"type":"string","description":"Legal first name as it appears on government documents","example":"John","isRequired":true,"uniqueKey":"kycData.legalFirstName","typeLabel":"string"},"legalLastName":{"type":"string","description":"Legal last name as it appears on government documents","example":"Doe","isRequired":true,"uniqueKey":"kycData.legalLastName","typeLabel":"string"},"phoneNumber":{"type":"string","description":"Phone number in international E.164 format","example":"+12125551234","isRequired":true,"uniqueKey":"kycData.phoneNumber","typeLabel":"string"},"dateOfBirth":{"format":"date","type":"string","description":"Date of birth (ISO 8601 format: YYYY-MM-DD)","example":"1990-01-15","isRequired":true,"uniqueKey":"kycData.dateOfBirth","typeLabel":"string\u003cdate>"},"address":{"type":"object","properties":{"countryCode":{"enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NE","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SS","SE","SG","SH","SI","SK","SL","SM","SN","SO","SR","ST","SV","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"type":"string","description":"Two-letter country code (e.g., US for United States)","example":"US","isRequired":true,"uniqueKey":"kycData.address.countryCode","typeLabel":"enum\u003cstring>"},"streetLine1":{"minLength":4,"maxLength":35,"type":"string","description":"Street address including house/building number","example":"350 5th Avenue","isRequired":true,"uniqueKey":"kycData.address.streetLine1","typeLabel":"string"},"city":{"minLength":1,"type":"string","description":"Name of the city or town","example":"New York","isRequired":true,"uniqueKey":"kycData.address.city","typeLabel":"string"},"stateRegionProvince":{"type":"string","description":"State, region, or province","example":"NY","isRequired":true,"uniqueKey":"kycData.address.stateRegionProvince","typeLabel":"string"},"streetLine2":{"minLength":4,"maxLength":35,"type":"string","description":"Additional address information (apartment, suite, unit, etc.)","example":"Floor 21","uniqueKey":"kycData.address.streetLine2","typeLabel":"string"},"postalCode":{"type":"string","description":"Postal/ZIP code","example":"10016","uniqueKey":"kycData.address.postalCode","typeLabel":"string"},"locale":{"type":"string","description":"Locale for address formatting (default is 'en-US')","example":"en-US","uniqueKey":"kycData.address.locale","typeLabel":"string"}},"required":["countryCode","streetLine1","city","stateRegionProvince"],"additionalProperties":false,"title":"Customer Address Schema","description":"Address information for customer verification","isRequired":true,"uniqueKey":"kycData.address","typeLabel":"Customer Address Schema · object"},"nationalIdIssuingCountry":{"enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NE","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SS","SE","SG","SH","SI","SK","SL","SM","SN","SO","SR","ST","SV","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"type":"string","description":"The country the national identification document was issued in (ISO 3166-1 alpha-2 format)","example":"US","isRequired":true,"uniqueKey":"kycData.nationalIdIssuingCountry","typeLabel":"enum\u003cstring>"},"nationalIdType":{"minLength":1,"type":"string","description":"Type of national identification document (e.g., 'ssn', 'tin', 'cpf', etc.)","example":"SSN","isRequired":true,"uniqueKey":"kycData.nationalIdType","typeLabel":"string"},"nationalIdNumber":{"minLength":1,"type":"string","description":"National identification number (SSN, TIN, etc.)","example":"123-45-6789","isRequired":true,"uniqueKey":"kycData.nationalIdNumber","typeLabel":"string"},"employmentStatus":{"type":"string","description":"Employment status","enum":["EMPLOYED","SELF_EMPLOYED","UNEMPLOYED","RETIRED","STUDENT","HOMEMAKER"],"example":"EMPLOYED","isRequired":true,"uniqueKey":"kycData.employmentStatus","typeLabel":"enum\u003cstring>"},"mostRecentOccupation":{"type":"string","description":"Most recent occupation code from the Standard Occupational Classification (SOC) system. [View Occupation Codes](https://docs.fernhq.com/guides/create-and-verify-customers/occupation-codes)","enum":["132011","272011","152011","291291","519191","113012","112011","413011","172011","131011","194010","191010","172021","452011","532020","493011","532010","512011","533011","452021","392021","339011","392011","171011","173011","119041","254010","271010","192010","272021","192021","291181","492097","493021","493022","493023","492091","396010","333011","513011","395011","353011","433011","433021","172031","191020","194021","472011","433031","472020","273011","274010","434011","132031","493031","131199","513020","131021","517011","292031","435011","472031","472040","412010","472050","351011","172041","519010","194031","192030","111011","211021","399011","291011","172051","131030","537061","212011","193033","292010","272022","499091","271021","499092","432099","113111","131141","131041","151221","113021","172061","151241","519160","151299","151251","151230","151211","492011","191030","474011","472070","472061","119021","499010","5370XX","352010","333012","434021","131051","211019","412021","435021","273092","434031","537021","132041","434041","132070","339091","519020","434051","519030","514031","272030","439021","15124X","519080","319091","291292","291020","475010","439031","333021","292032","29205X","291031","359011","212021","272091","359021","435032","419091","533030","472080","475023","193011","273041","119030","211012","492092","173023","172070","492093","49209X","499051","512020","472111","492096","252020","474021","434061","3940XX","119161","292042","291214","512031","172199","272099","119070","172081","194040","192041","519194","475022","436011","291128","399031","475032","519041","113013","119013","271022","353023","474031","434071","132051","433099","132061","113031","332020","332011","552010","471011","331011","451011","331021","351012","371011","371012","491011","411012","431011","331012","511011","331099","411011","331091","333031","453031","532031","271023","513091","513092","513093","359099","352021","513099","353041","119051","454011","514020","131131","119171","519051","517021","433041","393010","111021","19204X","472121","452041","271024","514033","395012","474041","291299","211022","499021","493040","499098","519198","473010","474051","499031","311121","359031","434081","434161","113121","131070","49904X","172110","113051","537051","434199","151212","519061","472130","439041","413021","132053","271025","273091","434111","37201X","519071","231020","231012","537062","171012","373011","516011","231011","436012","232099","111031","254022","434121","254031","292061","191099","434131","499094","534010","119081","454020","131081","537063","514041","292035","372012","439051","499071","499043","131111","119199","395092","499095","172121","131161","112021","211013","319011","172131","152021","172141","274099","273099","119111","319092","292072","191040","436013","319094","131121","211023","211014","271026","514050","435041","553010","551010","554010","499044","172151","452090","474090","292090","518090","193090","493090","514060","419010","514070","519195","394031","533099","272041","272042","119121","151244","434141","273023","172161","29203X","194051","291151","291161","291171","311131","195010","291122","312010","439199","439061","439071","152031","292081","291041","434151","31113X","5120XX","21109X","27102X","17301X","2590XX","17302X","3930XX","4750XX","1320XX","37301X","299000","31909X","49909X","1940XX","51403X","5371XX","1520XX","514XXX","39509X","2912XX","51919X","5191XX","33909X","19303X","5340XX","2530XX","51609X","5360XX","5170XX","519111","537064","472140","519120","519196","232011","292043","536021","333041","412022","536061","433051","399099","132052","119179","372021","172171","291051","319095","292052","319097","274021","519151","192099","291123","312020","291071","472151","472161","472152","291081","333050","435051","435052","435053","119131","251000","518010","499060","515111","252010","516021","515113","515112","339021","211092","433061","272012","435061","131082","439081","132020","119141","292053","112030","273031","435031","537070","131023","113061","291124","492020","292034","291224","474061","534031","419020","434171","399032","291125","537081","291141","211015","472171","212099","434181","399041","291126","412031","499096","472181","475071","535011","419099","419031","112022","413091","414010","517041","533051","339094","193034","252030","436014","413031","492098","339030","474071","516031","472211","535020","535031","435071","516040","533053","395094","493050","119151","211093","194061","211029","193041","151252","151253","472231","252050","291127","518021","439111","152041","537065","472221","512041","211011","391000","531000","291240","292055","193022","173031","171020","432011","516050","132081","132082","533054","259040","273042","499052","419041","432021","274030","433071","516060","291129","519197","232093","514111","397010","113131","131151","533052","536051","339093","536030","113071","413041","373013","253041","272023","475040","999999","516093","193051","393031","291131","319096","292056","353031","518031","151255","151254","435111","514120","131022","499081","517042","439022","273043"],"example":"132011","isRequired":true,"uniqueKey":"kycData.mostRecentOccupation","typeLabel":"enum\u003cstring>"},"sourceOfFunds":{"type":"string","description":"Source of funds","enum":["COMPANY_FUNDS","E_COMMERCE_RESELLER","GAMBLING_PROCEEDS","GIFTS","GOVERNMENT_BENEFITS","INHERITANCE","INVESTMENTS_OR_LOANS","PENSION_OR_RETIREMENT","PROCEEDS_FROM_REAL_ESTATE_SALES","SALARY","SAVINGS","SOMEONE_ELSES_FUNDS"],"example":"SALARY","isRequired":true,"uniqueKey":"kycData.sourceOfFunds","typeLabel":"enum\u003cstring>"},"accountPurpose":{"type":"string","description":"Purpose of the account","enum":["CHARITABLE_DONATIONS","COMPANY_OPERATIONS","E_COMMERCE_PAYMENTS","FREELANCE_PAYMENTS","INVESTMENT","PAYMENTS_TO_FRIENDS_FAMILY_ABROAD","PERSONAL_EXPENSES","PURCHASING_GOODS_OR_SERVICES","SALARY_PAYMENTS","WEALTH_PROTECTION","OTHER"],"example":"PERSONAL_EXPENSES","isRequired":true,"uniqueKey":"kycData.accountPurpose","typeLabel":"enum\u003cstring>"},"expectedMonthlyPaymentsUsd":{"type":"string","description":"Expected monthly payment volume in USD","enum":["LESS_THAN_5000","BETWEEN_5000_9999","BETWEEN_10000_49999","OVER_50000"],"example":"BETWEEN_5000_9999","isRequired":true,"uniqueKey":"kycData.expectedMonthlyPaymentsUsd","typeLabel":"enum\u003cstring>"},"documents":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of document","enum":["GOVERNMENT_ID","PROOF_OF_ADDRESS"],"example":"GOVERNMENT_ID","isRequired":true,"uniqueKey":"kycData.documents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"subtype":{"type":"string","description":"Document subtype","enum":["NATIONAL_ID","DRIVERS_LICENSE","PASSPORT","BANK_STATEMENT"],"example":"NATIONAL_ID","isRequired":true,"uniqueKey":"kycData.documents.items.[INDEX].subtype","typeLabel":"enum\u003cstring>"},"countryCode":{"type":"string","description":"Country code in ISO 3166-1 alpha-2 format (required for government ID documents)","example":"US","uniqueKey":"kycData.documents.items.[INDEX].countryCode","typeLabel":"string"},"documentIdNumber":{"type":"string","description":"Document ID number (for government IDs)","example":"123456789","uniqueKey":"kycData.documents.items.[INDEX].documentIdNumber","typeLabel":"string"},"issuanceDate":{"format":"date","type":"string","description":"Document issuance date (ISO 8601 format: YYYY-MM-DD)","example":"2020-01-15","uniqueKey":"kycData.documents.items.[INDEX].issuanceDate","typeLabel":"string\u003cdate>"},"expirationDate":{"format":"date","type":"string","description":"Document expiration date (ISO 8601 format: YYYY-MM-DD)","example":"2030-01-15","uniqueKey":"kycData.documents.items.[INDEX].expirationDate","typeLabel":"string\u003cdate>"},"frontIdImage":{"type":"string","description":"Base64 encoded front image of government ID","uniqueKey":"kycData.documents.items.[INDEX].frontIdImage","typeLabel":"string"},"backIdImage":{"type":"string","description":"Base64 encoded back image of government ID","uniqueKey":"kycData.documents.items.[INDEX].backIdImage","typeLabel":"string"},"proofOfAddressImage":{"type":"string","description":"Base64 encoded image of proof of address document","uniqueKey":"kycData.documents.items.[INDEX].proofOfAddressImage","typeLabel":"string"},"description":{"type":"string","description":"Description of the document (required when the document type is other).","example":"Electric bill from January 2024","uniqueKey":"kycData.documents.items.[INDEX].description","typeLabel":"string"}},"required":["type","subtype"],"additionalProperties":false,"title":"KYC Document","description":"Document information for KYC verification","uniqueKey":"kycData.documents.items.[INDEX]","typeLabel":"KYC Document · object"},"description":"Array of KYC documents","minItems":1,"isRequired":true,"uniqueKey":"kycData.documents","typeLabel":"KYC Document · object[]"},"legalMiddleName":{"type":"string","description":"Legal middle name as it appears on government documents","example":"Michael","uniqueKey":"kycData.legalMiddleName","typeLabel":"string"},"nationality":{"enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NE","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SS","SE","SG","SH","SI","SK","SL","SM","SN","SO","SR","ST","SV","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"type":"string","description":"Nationality/citizenship of the individual (ISO 3166-1 alpha-2 format)","example":"US","uniqueKey":"kycData.nationality","typeLabel":"enum\u003cstring>"},"accountPurposeOther":{"type":"string","description":"Other account purpose (required when accountPurpose is 'OTHER')","example":"Custom business purpose","uniqueKey":"kycData.accountPurposeOther","typeLabel":"string"},"isIntermediary":{"type":"boolean","description":"Whether individual is using the account on behalf of another entity","default":false,"example":false,"uniqueKey":"kycData.isIntermediary","typeLabel":"boolean"}},"required":["legalFirstName","legalLastName","phoneNumber","dateOfBirth","address","nationalIdIssuingCountry","nationalIdType","nationalIdNumber","employmentStatus","mostRecentOccupation","sourceOfFunds","accountPurpose","expectedMonthlyPaymentsUsd","documents"],"additionalProperties":false,"title":"KYC Data (Create)","description":"Optional KYC data for immediate verification submission.","uniqueKey":"kycData","typeLabel":"KYC Data (Create) · object"},"kybData":{"type":"object","properties":{"businessInfo":{"type":"object","properties":{"legalBusinessName":{"type":"string","description":"Legal name of the business","example":"Acme Corporation","isRequired":true,"uniqueKey":"kybData.businessInfo.legalBusinessName","typeLabel":"string"},"businessType":{"type":"string","description":"Type of business entity","enum":["B_CORPORATION","C_CORPORATION","S_CORPORATION","CLOSE_CORPORATION","COOPERATIVE","GENERAL_PARTNERSHIP","LIMITED_PARTNERSHIP","LIMITED_LIABILITY_PARTNERSHIP","LIMITED_LIABILITY_COMPANY","NONPROFIT_CORPORATION","SOLE_PROPRIETORSHIP","TRUST","OTHER","INDIVIDUAL"],"example":"C_CORPORATION","isRequired":true,"uniqueKey":"kybData.businessInfo.businessType","typeLabel":"enum\u003cstring>"},"businessIndustries":{"type":"string","description":"Business industry NAICS code","enum":["111110","111120","111130","111140","111150","111160","111191","111199","111211","111219","111310","111320","111331","111332","111333","111334","111335","111336","111339","111411","111419","111421","111422","111910","111920","111930","111940","111991","111992","111998","112111","112112","112120","112210","112310","112320","112330","112340","112390","112410","112420","112511","112512","112519","112910","112920","112930","112990","113110","113210","113310","114111","114112","114119","114210","115111","115112","115113","115114","115115","115116","115210","115310","211120","211130","212114","212115","212210","212220","212230","212290","212311","212312","212313","212319","212321","212322","212323","212390","213111","213112","213113","213114","213115","221111","221112","221113","221114","221115","221116","221117","221118","221121","221122","221210","221310","221320","221330","236115","236116","236117","236118","236210","236220","237110","237120","237130","237210","237310","237990","238110","238111","238112","238121","238122","238131","238132","238140","238141","238142","238151","238152","238160","238161","238162","238171","238172","238191","238192","238210","238211","238212","238220","238221","238222","238291","238292","238311","238312","238321","238322","238331","238332","238341","238342","238350","238351","238352","238391","238392","238911","238912","238990","238991","238992","311111","311119","311211","311212","311213","311221","311224","311225","311230","311313","311314","311340","311351","311352","311411","311412","311421","311422","311423","311511","311512","311513","311514","311520","311611","311612","311613","311615","311710","311811","311812","311813","311821","311824","311830","311911","311919","311920","311930","311941","311942","311991","311999","312111","312112","312113","312120","312130","312140","312230","313110","313210","313220","313230","313240","313310","313320","314110","314120","314910","314994","314999","315120","315210","315250","315990","316110","316210","316990","321113","321114","321211","321212","321215","321219","321911","321912","321918","321920","321991","321992","321999","322110","322120","322130","322211","322212","322219","322220","322230","322291","322299","323111","323113","323117","323120","324110","324121","324122","324191","324199","325110","325120","325130","325180","325193","325194","325199","325211","325212","325220","325311","325312","325314","325315","325320","325411","325412","325413","325414","325510","325520","325611","325612","325613","325620","325910","325920","325991","325992","325998","326111","326112","326113","326121","326122","326130","326140","326150","326160","326191","326199","326211","326212","326220","326291","326299","327110","327120","327211","327212","327213","327215","327310","327320","327331","327332","327390","327410","327420","327910","327991","327992","327993","327999","331110","331210","331221","331222","331313","331314","331315","331318","331410","331420","331491","331492","331511","331512","331513","331523","331524","331529","332111","332112","332114","332117","332119","332215","332216","332311","332312","332313","332321","332322","332323","332410","332420","332431","332439","332510","332613","332618","332710","332721","332722","332811","332812","332813","332911","332912","332913","332919","332991","332992","332993","332994","332996","332999","333111","333112","333120","333131","333132","333241","333242","333243","333248","333310","333413","333414","333415","333511","333514","333515","333517","333519","333611","333612","333613","333618","333912","333914","333921","333922","333923","333924","333991","333992","333993","333994","333995","333996","333998","334111","334112","334118","334210","334220","334290","334310","334412","334413","334416","334417","334418","334419","334510","334511","334512","334513","334514","334515","334516","334517","334519","334610","335131","335132","335139","335210","335220","335311","335312","335313","335314","335910","335921","335929","335931","335932","335991","335999","336110","336120","336211","336212","336213","336214","336310","336320","336330","336340","336350","336360","336370","336390","336411","336412","336413","336414","336415","336419","336510","336611","336612","336991","336992","336999","337110","337121","337122","337126","337127","337211","337212","337214","337215","337910","337920","339112","339113","339114","339115","339116","339910","339920","339930","339940","339950","339991","339992","339993","339994","339995","339999","423110","423120","423130","423140","423210","423220","423310","423320","423330","423390","423410","423420","423430","423440","423450","423460","423490","423510","423520","423610","423620","423690","423710","423720","423730","423740","423810","423820","423830","423840","423850","423860","423910","423920","423930","423940","423990","424110","424120","424130","424210","424310","424340","424350","424410","424420","424430","424440","424450","424460","424470","424480","424490","424510","424520","424590","424610","424690","424710","424720","424810","424820","424910","424920","424930","424940","424950","424990","425120","441110","441120","441210","441222","441227","441330","441340","444110","444120","444140","444180","444230","444240","445110","445131","445132","445230","445240","445250","445291","445292","445298","445320","449110","449121","449122","449129","449210","454113","454390","455110","455211","455219","456110","456120","456130","456191","456199","457110","457120","457210","458110","458210","458310","458320","459110","459120","459130","459140","459210","459310","459410","459420","459510","459910","459920","459930","459991","459999","481111","481112","481211","481212","481219","482111","482112","483111","483112","483113","483114","483211","483212","484110","484121","484122","484210","484220","484230","485111","485112","485113","485119","485210","485310","485320","485410","485510","485991","485999","486110","486210","486910","486990","487110","487210","487990","488111","488119","488190","488210","488310","488320","488330","488390","488410","488490","488510","488991","488999","491110","492110","492210","493110","493120","493130","493190","512110","512120","512131","512132","512191","512199","512230","512240","512250","512290","513110","513120","513130","513140","513191","513199","513210","515210","516110","516120","516210","517111","517112","517121","517410","517810","518210","519210","519290","521110","522110","522130","522180","522210","522220","522291","522292","522298","522299","522310","522320","522390","523150","523160","523210","523910","523940","523991","523999","524113","524114","524126","524127","524128","524130","524210","524291","524292","524298","525110","525120","525190","525910","525920","525990","531110","531120","531130","531190","531210","531311","531312","531320","531390","532111","532112","532120","532210","532281","532282","532283","532284","532289","532310","532411","532412","532420","532490","533110","541110","541191","541199","541211","541213","541214","541219","541310","541320","541330","541340","541350","541360","541370","541380","541410","541420","541430","541490","541511","541512","541513","541519","541611","541612","541613","541614","541618","541620","541690","541713","541714","541715","541720","541810","541820","541830","541840","541850","541860","541870","541890","541910","541921","541922","541930","541940","541990","551111","551112","551114","561110","561210","561311","561312","561320","561330","561410","561421","561422","561431","561439","561440","561450","561491","561492","561499","561510","561520","561591","561599","561611","561612","561613","561621","561622","561710","561720","561730","561740","561790","561910","561920","561990","562111","562112","562119","562211","562212","562213","562219","562910","562920","562991","562998","611110","611210","611310","611410","611420","611430","611511","611512","611513","611519","611610","611620","611630","611691","611692","611699","611710","621111","621112","621210","621310","621320","621330","621340","621391","621399","621410","621420","621491","621492","621493","621498","621511","621512","621610","621910","621991","621999","622110","622210","622310","623110","623210","623220","623311","623312","623990","624110","624120","624190","624210","624221","624229","624230","624310","624410","711110","711120","711130","711190","711211","711212","711219","711310","711320","711410","711510","712110","712120","712130","712190","713110","713120","713210","713290","713910","713920","713930","713940","713950","713990","721110","721120","721191","721199","721211","721214","721310","722310","722320","722330","722410","722511","722513","722514","722515","811111","811114","811121","811122","811191","811192","811198","811210","811310","811411","811412","811420","811430","811490","812111","812112","812113","812191","812199","812210","812220","812310","812320","812331","812332","812910","812921","812922","812930","812990","813110","813211","813212","813219","813311","813312","813319","813410","813910","813920","813930","813940","813990","814110","921110","921120","921130","921140","921150","921190","922110","922120","922130","922140","922150","922160","922190","923110","923120","923130","923140","924110","924120","925110","925120","926110","926120","926130","926140","926150","927110","928110","928120","999999"],"example":"541511","isRequired":true,"uniqueKey":"kybData.businessInfo.businessIndustries","typeLabel":"enum\u003cstring>"},"businessDescription":{"type":"string","description":"Description of business activities","example":"Software development and consulting services","isRequired":true,"uniqueKey":"kybData.businessInfo.businessDescription","typeLabel":"string"},"website":{"format":"uri","type":"string","description":"Business website URL","example":"https://www.acme.com","isRequired":true,"uniqueKey":"kybData.businessInfo.website","typeLabel":"string\u003curi>"},"formationDate":{"format":"date","type":"string","description":"Date of business formation (ISO 8601 format: YYYY-MM-DD)","example":"2020-01-15","isRequired":true,"uniqueKey":"kybData.businessInfo.formationDate","typeLabel":"string\u003cdate>"},"dbaName":{"type":"string","description":"DBA or trade name if different from legal name","example":"Acme Corp","uniqueKey":"kybData.businessInfo.dbaName","typeLabel":"string"},"otherLinks":{"type":"array","items":{"format":"uri","type":"string","uniqueKey":"kybData.businessInfo.otherLinks.items.[INDEX]","typeLabel":"string\u003curi>"},"description":"Other relevant business links (can include social media handles)","example":["https://linkedin.com/company/acme","@acmetech"],"uniqueKey":"kybData.businessInfo.otherLinks","typeLabel":"string\u003curi>[]"},"registrationCountry":{"enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NE","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SS","SE","SG","SH","SI","SK","SL","SM","SN","SO","SR","ST","SV","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"type":"string","description":"Country of business registration (ISO 3166-1 alpha-2 code)","example":"US","uniqueKey":"kybData.businessInfo.registrationCountry","typeLabel":"enum\u003cstring>"},"isDao":{"type":"boolean","description":"Whether the business is a DAO","default":false,"example":false,"uniqueKey":"kybData.businessInfo.isDao","typeLabel":"boolean"}},"required":["legalBusinessName","businessType","businessIndustries","businessDescription","website","formationDate"],"additionalProperties":false,"description":"Business information","isRequired":true,"uniqueKey":"kybData.businessInfo","typeLabel":"object"},"businessRegisteredAddress":{"type":"object","properties":{"countryCode":{"enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NE","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SS","SE","SG","SH","SI","SK","SL","SM","SN","SO","SR","ST","SV","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"type":"string","description":"Two-letter country code (e.g., US for United States)","example":"US","isRequired":true,"uniqueKey":"kybData.businessRegisteredAddress.countryCode","typeLabel":"enum\u003cstring>"},"streetLine1":{"minLength":4,"maxLength":35,"type":"string","description":"Street address including house/building number","example":"350 5th Avenue","isRequired":true,"uniqueKey":"kybData.businessRegisteredAddress.streetLine1","typeLabel":"string"},"city":{"minLength":1,"type":"string","description":"Name of the city or town","example":"New York","isRequired":true,"uniqueKey":"kybData.businessRegisteredAddress.city","typeLabel":"string"},"stateRegionProvince":{"type":"string","description":"State, region, or province","example":"NY","isRequired":true,"uniqueKey":"kybData.businessRegisteredAddress.stateRegionProvince","typeLabel":"string"},"streetLine2":{"minLength":4,"maxLength":35,"type":"string","description":"Additional address information (apartment, suite, unit, etc.)","example":"Floor 21","uniqueKey":"kybData.businessRegisteredAddress.streetLine2","typeLabel":"string"},"postalCode":{"type":"string","description":"Postal/ZIP code","example":"10016","uniqueKey":"kybData.businessRegisteredAddress.postalCode","typeLabel":"string"},"locale":{"type":"string","description":"Locale for address formatting (default is 'en-US')","example":"en-US","uniqueKey":"kybData.businessRegisteredAddress.locale","typeLabel":"string"}},"required":["countryCode","streetLine1","city","stateRegionProvince"],"additionalProperties":false,"title":"Customer Address Schema","description":"Address information for customer verification","isRequired":true,"uniqueKey":"kybData.businessRegisteredAddress","typeLabel":"Customer Address Schema · object"},"businessRegistrationNumber":{"type":"string","description":"Business registration number. For non-sole proprietorships the relevant individual tax number is required. For example in the US an Employer Identification Number (EIN) is required.","example":"12-3456789","isRequired":true,"uniqueKey":"kybData.businessRegistrationNumber","typeLabel":"string"},"sourceOfFunds":{"type":"string","description":"Primary source of business funds","enum":["BUSINESS_LOANS","GRANTS","INTER_COMPANY_FUNDS","INVESTMENT_PROCEEDS","LEGAL_SETTLEMENT","OWNERS_CAPITAL","PENSION_OR_RETIREMENT","SALE_OF_ASSETS","SALE_OF_GOODS_AND_SERVICES","TAX_REFUND","THIRD_PARTY_FUNDS","TREASURY_RESERVES"],"example":"SALE_OF_GOODS_AND_SERVICES","isRequired":true,"uniqueKey":"kybData.sourceOfFunds","typeLabel":"enum\u003cstring>"},"accountPurpose":{"type":"string","description":"Purpose of the business account","enum":["CHARITABLE_DONATIONS","E_COMMERCE_PAYMENTS","INVESTMENT","PAYMENTS_TO_FRIENDS_FAMILY_ABROAD","PERSONAL_EXPENSES","PURCHASING_GOODS_OR_SERVICES","PAYROLL","RECEIVING_GOODS_OR_SERVICES","TAX_OPTIMIZATION","THIRD_PARTY_PAYMENTS","TREASURY_MANAGEMENT","WEALTH_PROTECTION","OTHER"],"example":"CHARITABLE_DONATIONS","isRequired":true,"uniqueKey":"kybData.accountPurpose","typeLabel":"enum\u003cstring>"},"expectedMonthlyVolumeUsd":{"type":"string","description":"Expected monthly payment volume in USD","enum":["LESS_THAN_10000","BETWEEN_10000_99999","BETWEEN_100000_999999","BETWEEN_1000000_9999999","OVER_10000000"],"example":"BETWEEN_10000_99999","isRequired":true,"uniqueKey":"kybData.expectedMonthlyVolumeUsd","typeLabel":"enum\u003cstring>"},"estimatedAnnualRevenueUsd":{"type":"string","description":"Estimated annual revenue in USD","enum":["LESS_THAN_100000","BETWEEN_100000_999999","BETWEEN_1000000_9999999","BETWEEN_10000000_49999999","BETWEEN_50000000_249999999","OVER_250000000"],"example":"BETWEEN_100000_999999","isRequired":true,"uniqueKey":"kybData.estimatedAnnualRevenueUsd","typeLabel":"enum\u003cstring>"},"associatedPersons":{"type":"array","items":{"type":"object","properties":{"legalFirstName":{"type":"string","description":"Legal first name of the applicant as it appears on government documents","example":"Jane","isRequired":true,"uniqueKey":"kybData.associatedPersons.items.[INDEX].legalFirstName","typeLabel":"string"},"legalLastName":{"type":"string","description":"Legal last name of the applicant as it appears on government documents","example":"Smith","isRequired":true,"uniqueKey":"kybData.associatedPersons.items.[INDEX].legalLastName","typeLabel":"string"},"email":{"format":"email","type":"string","description":"Email address","example":"jane.smith@example.com","isRequired":true,"uniqueKey":"kybData.associatedPersons.items.[INDEX].email","typeLabel":"string\u003cemail>"},"phoneNumber":{"type":"string","description":"Phone number in international format","example":"+14155551234","isRequired":true,"uniqueKey":"kybData.associatedPersons.items.[INDEX].phoneNumber","typeLabel":"string"},"dateOfBirth":{"format":"date","type":"string","description":"Date of birth (ISO 8601 format: YYYY-MM-DD)","example":"1985-06-20","isRequired":true,"uniqueKey":"kybData.associatedPersons.items.[INDEX].dateOfBirth","typeLabel":"string\u003cdate>"},"address":{"type":"object","properties":{"countryCode":{"enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NE","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SS","SE","SG","SH","SI","SK","SL","SM","SN","SO","SR","ST","SV","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"type":"string","description":"Two-letter country code (e.g., US for United States)","example":"US","isRequired":true,"uniqueKey":"kybData.associatedPersons.items.[INDEX].address.countryCode","typeLabel":"enum\u003cstring>"},"streetLine1":{"minLength":4,"maxLength":35,"type":"string","description":"Street address including house/building number","example":"350 5th Avenue","isRequired":true,"uniqueKey":"kybData.associatedPersons.items.[INDEX].address.streetLine1","typeLabel":"string"},"city":{"minLength":1,"type":"string","description":"Name of the city or town","example":"New York","isRequired":true,"uniqueKey":"kybData.associatedPersons.items.[INDEX].address.city","typeLabel":"string"},"stateRegionProvince":{"type":"string","description":"State, region, or province","example":"NY","isRequired":true,"uniqueKey":"kybData.associatedPersons.items.[INDEX].address.stateRegionProvince","typeLabel":"string"},"streetLine2":{"minLength":4,"maxLength":35,"type":"string","description":"Additional address information (apartment, suite, unit, etc.)","example":"Floor 21","uniqueKey":"kybData.associatedPersons.items.[INDEX].address.streetLine2","typeLabel":"string"},"postalCode":{"type":"string","description":"Postal/ZIP code","example":"10016","uniqueKey":"kybData.associatedPersons.items.[INDEX].address.postalCode","typeLabel":"string"},"locale":{"type":"string","description":"Locale for address formatting (default is 'en-US')","example":"en-US","uniqueKey":"kybData.associatedPersons.items.[INDEX].address.locale","typeLabel":"string"}},"required":["countryCode","streetLine1","city","stateRegionProvince"],"additionalProperties":false,"title":"Customer Address Schema","description":"Address information for customer verification","isRequired":true,"uniqueKey":"kybData.associatedPersons.items.[INDEX].address","typeLabel":"Customer Address Schema · object"},"legalMiddleName":{"type":"string","description":"Legal middle name of the applicant as it appears on government documents","example":"Marie","uniqueKey":"kybData.associatedPersons.items.[INDEX].legalMiddleName","typeLabel":"string"},"ownershipPercentage":{"minimum":0,"maximum":1,"type":"number","description":"Ownership percentage as decimal (0-1). Not applicable for a controller unless they are also an owner.","example":0.25,"uniqueKey":"kybData.associatedPersons.items.[INDEX].ownershipPercentage","typeLabel":"number"},"title":{"type":"string","description":"Professional title within the company","example":"Chief Technology Officer","uniqueKey":"kybData.associatedPersons.items.[INDEX].title","typeLabel":"string"},"isControlPerson":{"type":"boolean","description":"Whether this person is a control person","default":false,"example":true,"uniqueKey":"kybData.associatedPersons.items.[INDEX].isControlPerson","typeLabel":"boolean"},"isSigner":{"type":"boolean","description":"Whether this person has signing authority","default":false,"example":true,"uniqueKey":"kybData.associatedPersons.items.[INDEX].isSigner","typeLabel":"boolean"},"isDirector":{"type":"boolean","description":"Whether this person is a director","default":false,"example":false,"uniqueKey":"kybData.associatedPersons.items.[INDEX].isDirector","typeLabel":"boolean"},"nationalIdIssuingCountry":{"enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NE","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SS","SE","SG","SH","SI","SK","SL","SM","SN","SO","SR","ST","SV","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"type":"string","description":"The country the national identification document was issued in (ISO 3166-1 alpha-2 format)","example":"US","uniqueKey":"kybData.associatedPersons.items.[INDEX].nationalIdIssuingCountry","typeLabel":"enum\u003cstring>"},"nationalIdType":{"minLength":1,"type":"string","description":"Type of national ID (e.g. ssn)","example":"ssn","uniqueKey":"kybData.associatedPersons.items.[INDEX].nationalIdType","typeLabel":"string"},"nationalIdNumber":{"minLength":1,"type":"string","description":"National ID number (e.g. Social Security Number)","example":"123-45-6789","uniqueKey":"kybData.associatedPersons.items.[INDEX].nationalIdNumber","typeLabel":"string"},"nationality":{"enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NE","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SS","SE","SG","SH","SI","SK","SL","SM","SN","SO","SR","ST","SV","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"type":"string","description":"Nationality/citizenship of the individual (ISO 3166-1 alpha-2 format)","example":"US","uniqueKey":"kybData.associatedPersons.items.[INDEX].nationality","typeLabel":"enum\u003cstring>"},"documents":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of document for KYB associated person","enum":["GOVERNMENT_ID","PROOF_OF_ADDRESS"],"example":"GOVERNMENT_ID","isRequired":true,"uniqueKey":"kybData.associatedPersons.items.[INDEX].documents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"subtype":{"type":"string","description":"Document subtype for KYB associated person","enum":["NATIONAL_ID","DRIVERS_LICENSE","PASSPORT","BANK_STATEMENT"],"example":"NATIONAL_ID","isRequired":true,"uniqueKey":"kybData.associatedPersons.items.[INDEX].documents.items.[INDEX].subtype","typeLabel":"enum\u003cstring>"},"countryCode":{"type":"string","description":"Country code in ISO 3166-1 alpha-2 format (required for government ID documents)","example":"US","uniqueKey":"kybData.associatedPersons.items.[INDEX].documents.items.[INDEX].countryCode","typeLabel":"string"},"documentIdNumber":{"type":"string","description":"Document ID number (for government IDs)","example":"123456789","uniqueKey":"kybData.associatedPersons.items.[INDEX].documents.items.[INDEX].documentIdNumber","typeLabel":"string"},"issuanceDate":{"format":"date","type":"string","description":"Document issuance date (ISO 8601 format: YYYY-MM-DD)","example":"2020-01-15","uniqueKey":"kybData.associatedPersons.items.[INDEX].documents.items.[INDEX].issuanceDate","typeLabel":"string\u003cdate>"},"expirationDate":{"format":"date","type":"string","description":"Document expiration date (ISO 8601 format: YYYY-MM-DD)","example":"2030-01-15","uniqueKey":"kybData.associatedPersons.items.[INDEX].documents.items.[INDEX].expirationDate","typeLabel":"string\u003cdate>"},"frontIdImage":{"type":"string","description":"Base64 encoded front image of government ID","uniqueKey":"kybData.associatedPersons.items.[INDEX].documents.items.[INDEX].frontIdImage","typeLabel":"string"},"backIdImage":{"type":"string","description":"Base64 encoded back image of government ID (required for DRIVERS_LICENSE and NATIONAL_ID, not required for PASSPORT)","uniqueKey":"kybData.associatedPersons.items.[INDEX].documents.items.[INDEX].backIdImage","typeLabel":"string"},"proofOfAddressImage":{"type":"string","description":"Base64 encoded image of proof of address document","uniqueKey":"kybData.associatedPersons.items.[INDEX].documents.items.[INDEX].proofOfAddressImage","typeLabel":"string"},"description":{"type":"string","description":"Description of the document (required when the document type is other).","example":"Bank statement for KYB associated person","uniqueKey":"kybData.associatedPersons.items.[INDEX].documents.items.[INDEX].description","typeLabel":"string"}},"required":["type","subtype"],"additionalProperties":false,"title":"KYB Associated Person Document","description":"Document information for KYB associated person verification - separate validation rules from individual KYC","uniqueKey":"kybData.associatedPersons.items.[INDEX].documents.items.[INDEX]","typeLabel":"KYB Associated Person Document · object"},"description":"Array of KYC documents for this applicant","uniqueKey":"kybData.associatedPersons.items.[INDEX].documents","typeLabel":"KYB Associated Person Document · object[]"}},"required":["legalFirstName","legalLastName","email","phoneNumber","dateOfBirth","address"],"additionalProperties":false,"title":"KYB Applicant","description":"Information about an applicant (controller, beneficial owner, or sole proprietor) for the business","uniqueKey":"kybData.associatedPersons.items.[INDEX]","typeLabel":"KYB Applicant · object"},"minItems":1,"description":"A list of associated persons (ultimate beneficial owners, controllers, and other individuals who are associated with the business).","isRequired":true,"uniqueKey":"kybData.associatedPersons","typeLabel":"KYB Applicant · object[]"},"businessOperatingAddress":{"type":"object","properties":{"countryCode":{"enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NE","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SS","SE","SG","SH","SI","SK","SL","SM","SN","SO","SR","ST","SV","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"type":"string","description":"Two-letter country code (e.g., US for United States)","example":"US","isRequired":true,"uniqueKey":"kybData.businessOperatingAddress.countryCode","typeLabel":"enum\u003cstring>"},"streetLine1":{"minLength":4,"maxLength":35,"type":"string","description":"Street address including house/building number","example":"350 5th Avenue","isRequired":true,"uniqueKey":"kybData.businessOperatingAddress.streetLine1","typeLabel":"string"},"city":{"minLength":1,"type":"string","description":"Name of the city or town","example":"New York","isRequired":true,"uniqueKey":"kybData.businessOperatingAddress.city","typeLabel":"string"},"stateRegionProvince":{"type":"string","description":"State, region, or province","example":"NY","isRequired":true,"uniqueKey":"kybData.businessOperatingAddress.stateRegionProvince","typeLabel":"string"},"streetLine2":{"minLength":4,"maxLength":35,"type":"string","description":"Additional address information (apartment, suite, unit, etc.)","example":"Floor 21","uniqueKey":"kybData.businessOperatingAddress.streetLine2","typeLabel":"string"},"postalCode":{"type":"string","description":"Postal/ZIP code","example":"10016","uniqueKey":"kybData.businessOperatingAddress.postalCode","typeLabel":"string"},"locale":{"type":"string","description":"Locale for address formatting (default is 'en-US')","example":"en-US","uniqueKey":"kybData.businessOperatingAddress.locale","typeLabel":"string"}},"required":["countryCode","streetLine1","city","stateRegionProvince"],"additionalProperties":false,"title":"Customer Address Schema","description":"Address information for customer verification","uniqueKey":"kybData.businessOperatingAddress","typeLabel":"Customer Address Schema · object"},"sourceOfFundsDescription":{"type":"string","description":"Additional details about source of funds","example":"Revenue from software licensing and consulting services","uniqueKey":"kybData.sourceOfFundsDescription","typeLabel":"string"},"accountPurposeOther":{"type":"string","description":"Other account purpose (required when accountPurpose is 'OTHER')","example":"Custom business purpose","uniqueKey":"kybData.accountPurposeOther","typeLabel":"string"},"conductsMoneyServices":{"type":"boolean","description":"Whether business conducts money services","default":false,"example":false,"uniqueKey":"kybData.conductsMoneyServices","typeLabel":"boolean"},"conductsMoneyServicesDescription":{"type":"string","description":"Description of money services if applicable","example":"International wire transfers for clients","uniqueKey":"kybData.conductsMoneyServicesDescription","typeLabel":"string"},"conductsMoneyServicesThroughFern":{"type":"boolean","description":"Whether money services are conducted through Fern","default":false,"example":false,"uniqueKey":"kybData.conductsMoneyServicesThroughFern","typeLabel":"boolean"},"operatesInProhibitedCountries":{"type":"boolean","description":"Whether business operates in prohibited/sanctioned countries","default":false,"example":false,"uniqueKey":"kybData.operatesInProhibitedCountries","typeLabel":"boolean"},"complianceScreeningDescription":{"type":"string","description":"Description of compliance screening processes","example":"We screen all clients against OFAC and international sanctions lists","uniqueKey":"kybData.complianceScreeningDescription","typeLabel":"string"},"highRiskActivities":{"type":"array","items":{"enum":["ADULT_ENTERTAINMENT","FOREIGN_EXCHANGE_OR_BROKERAGE","GAMBLING","HOLDING_CLIENT_FUNDS","INVESTMENT_SERVICES","LENDING_OR_BANKING","MARIJUANA_OR_RELATED_SERVICES","MONEY_SERVICES","NICOTINE_OR_TOBACCO_RELATED_SERVICES","PHARMACEUTICALS","PRECIOUS_METALS_STONES_OR_JEWELRY","SAFE_DEPOSIT_BOX_RENTALS","THIRD_PARTY_PAYMENT_PROCESSING","WEAPONS_FIREARMS_OR_EXPLOSIVES","NONE_OF_THE_ABOVE"],"type":"string","uniqueKey":"kybData.highRiskActivities.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"List of high-risk activities the business engages in","default":["NONE_OF_THE_ABOVE"],"example":["ADULT_ENTERTAINMENT","FOREIGN_EXCHANGE_OR_BROKERAGE"],"uniqueKey":"kybData.highRiskActivities","typeLabel":"enum\u003cstring>[]"},"highRiskActivitiesExplanation":{"type":"string","description":"Required explanation when high-risk activities are selected (except when only NONE_OF_THE_ABOVE is selected)","example":"We process cryptocurrency transactions for institutional clients","uniqueKey":"kybData.highRiskActivitiesExplanation","typeLabel":"string"},"businessDocuments":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of business document","enum":["BUSINESS_LICENSE","TRADE_NAME_REGISTRATION","TAX_FILING","PARTNERSHIP_AGREEMENT","CERTIFICATE_OF_PARTNERSHIP","REGISTRATION_CERTIFICATE","ARTICLES_OF_INCORPORATION","CERTIFICATE_OF_INCORPORATION","ARTICLES_OF_ORGANIZATION","OPERATING_AGREEMENT","MEMBERSHIP_CERTIFICATE","FORMATION_DOCUMENT","TRUST_DEED","BYLAWS","GOVERNING_DOCUMENTATION","BUSINESS_FORMATION","BUSINESS_OWNERSHIP","BUSINESS_NATURE","OTHER","BANK_STATEMENT","FLOW_OF_FUNDS_DOCUMENT"],"example":"ARTICLES_OF_INCORPORATION","isRequired":true,"uniqueKey":"kybData.businessDocuments.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"documentImage":{"type":"string","description":"Base64 encoded image of the document (required)","isRequired":true,"uniqueKey":"kybData.businessDocuments.items.[INDEX].documentImage","typeLabel":"string"},"description":{"type":"string","description":"Description of the document","example":"Articles of Incorporation filed in Delaware","uniqueKey":"kybData.businessDocuments.items.[INDEX].description","typeLabel":"string"}},"required":["type","documentImage"],"additionalProperties":false,"title":"Business Document","description":"Document information for KYB verification","uniqueKey":"kybData.businessDocuments.items.[INDEX]","typeLabel":"Business Document · object"},"description":"Business verification documents","uniqueKey":"kybData.businessDocuments","typeLabel":"Business Document · object[]"}},"required":["businessInfo","businessRegisteredAddress","businessRegistrationNumber","sourceOfFunds","accountPurpose","expectedMonthlyVolumeUsd","estimatedAnnualRevenueUsd","associatedPersons"],"additionalProperties":false,"title":"KYB Data (Create)","description":"Optional KYB data for immediate verification submission.","uniqueKey":"kybData","typeLabel":"KYB Data (Create) · object"}},"required":["customerType","email"],"additionalProperties":false,"title":"Create Customer Request Schema","description":"Request payload for creating a new customer account with optional KYC data","uniqueKey":"","typeLabel":"Create Customer Request Schema · object"},"examples":{"Example":{"title":"Example","value":{"email":"john.doe@example.com","firstName":"John","lastName":"Doe","businessName":"John Doe Inc."}}},"exampleType":"generated"}},"required":true,"description":"Request payload for creating a new customer account with optional KYC data","exampleType":"generated"},"responses":{"e1d0dffe-09f6-48ca-9b0a-0ece1e7da386":{"description":"Response schema for a customer retrieval request","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"format":"uuid","type":"string","description":"Unique identifier of the customer","example":"abc123","isRequired":true,"uniqueKey":"customerId","typeLabel":"string\u003cuuid>"},"customerStatus":{"enum":["CREATED","UNDER_REVIEW","NEEDS_ADDITIONAL_INFORMATION","ACTIVE","REJECTED","DEACTIVATED"],"type":"string","description":"Current status of the customer","example":"ACTIVE","isRequired":true,"uniqueKey":"customerStatus","typeLabel":"enum\u003cstring>"},"email":{"format":"email","type":"string","description":"Email of the customer","example":"john.doe@example.com","isRequired":true,"uniqueKey":"email","typeLabel":"string\u003cemail>"},"customerType":{"enum":["INDIVIDUAL","BUSINESS"],"type":"string","title":"Customer Type Enums","description":"The type of customer - either individual or business","isRequired":true,"uniqueKey":"customerType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"Full name of the customer or business","example":"John Doe","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"verificationLink":{"format":"uri","type":"string","description":"URL for KYC/KYB verification process","example":"https://forms.fernhq.com/verify-customer/0423300f-ae6d-4e82-8afb-a3b430e22e29","isRequired":true,"uniqueKey":"verificationLink","typeLabel":"string\u003curi>"},"updatedAt":{"format":"date-time","type":"string","description":"Timestamp of the last status update","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"organizationId":{"type":"string","description":"Organization identifier","example":"8469411c-48c1-4e26-a032-44688be9cb4b","isRequired":true,"uniqueKey":"organizationId","typeLabel":"string"},"availablePaymentMethods":{"type":"array","items":{"type":"string","uniqueKey":"availablePaymentMethods.items.[INDEX]","typeLabel":"string"},"enum":["Payment Method Schema","Payment method for source or destination transactions",[{"enum":["ACH","WIRE","SEPA","AE_UAEFTS","AR_TRANSFERS_3","AU_BECS","BD_BEFTN","BO_RTGS","BR_TED_DOC_PIX","CA_INTERAC","CL_TEF","CN_CNAPS","CO_ACH","CR_SINPE","CZ_CERTIS","DK_NEMKONTO_FI","DO_ACH","EC_LOCAL","EG_RTGS_IPN","GB_BACS_CHAPS_FPS","GH_GHIPSS","GT_ACH","HK_HKICL_CHATS_ECG","HU_GIRO","ID_SKN_RTGS","IL_ZAHAV","IN_NEFT_RTGS_IMPS","JM_LOCAL","JO_ACH","JP_ZENGIN","KE_KIBBS_PESALINK","KR_LOCAL","LK_LOCAL","MX_SPEI","MY_IBG_RENTAS","NG_NIBSS_NEFT","NO_NICS","NP_LOCAL","NZ_LOCAL","PE_CCE","PH_INSTAPAY_PESONET","PK_RAAST_IBFT","PL_ELIXIR_BLUE_CASH","QA_QPS","RO_RTGS","SA_MADA","SE_BANKGIROT","SG_FAST_MEPS","SV_LOCAL","SWIFT","TH_BAHTNET_PROMPTPAY","TR_FAST_EFT","TZ_RTGS","VN_IBPS","ZA_RTGS_EFT","ACH_SAME_DAY"],"title":"Fiat Payment Method","description":"The payment method for the source funds (fiat)","type":"string"},{"enum":["ARBITRUM","BASE","ETHEREUM","OPTIMISM","POLYGON","SOLANA"],"title":"Crypto Payment Method","description":"The payment method for the source funds (crypto)","type":"string"}]],"description":"Available payment methods for the customer","example":["ACH","WIRE","SEPA","CA_INTERAC","IN_NEFT_RTGS_IMPS","ARBITRUM","BASE","ETHEREUM","OPTIMISM","POLYGON","SOLANA"],"uniqueKey":"availablePaymentMethods","typeLabel":"string[]"},"verificationIssues":{"type":"array","items":{"type":"object","properties":{"code":{"enum":["DOCUMENT_MISSING_BACK","DOCUMENT_MISSING_FRONT","DOCUMENT_NUMBER_UNREADABLE","DOC_QUALITY_POOR","NAME_UNREADABLE","NO_FACE_PORTRAIT","MISSING_ID_DETAILS","DOCUMENT_EXPIRED","NO_GOVERNMENT_ID","INCORRECT_ID_TYPE","ID_REQUIRES_ADDITIONAL_VERIFICATION","ID_COUNTRY_MISMATCH","GOVERNMENT_ID_VERIFICATION_FAILED","DATABASE_CHECK_FAILED_ON_NAME_FIRST","DATABASE_CHECK_FAILED_ON_NAME_LAST","DATABASE_CHECK_FAILED_ON_SOCIAL_SECURITY_NUMBER","DATABASE_CHECK_FAILED_ON_STREET_NAME","DATABASE_CHECK_FAILED_ON_CITY","DATABASE_CHECK_FAILED_ON_SUBDIVISION","DATABASE_CHECK_FAILED_ON_POSTAL_CODE","ADDRESS_TOO_SHORT","INCONSISTENT_INFORMATION","INCONSISTENT_DETAILS","INVALID_PARAMETERS","VERIFICATION_ISSUE","API_ERROR","NAME_VERIFICATION_FAILED","ID_TYPE_MISMATCH","BIRTH_DATE_MISMATCH","ID_DATA_MISMATCH","ID_NUMBER_NOT_VERIFIED","MISSING_NAME","DOCUMENT_NOT_FOUND","UNREADABLE_DOCUMENT","UNRECOGNIZED_DOCUMENT","MISSING_DOCUMENT_NUMBER","MISSING_ISSUE_DATE","MISSING_EXPIRY_DATE","DOCUMENT_FRONT_OR_BACK_MISSING","DOCUMENT_BACK_MISSING","ID_NOT_ALLOWED","FACE_PREVIOUSLY_ONBOARDED","ID_PREVIOUSLY_SEEN","ID_PREVIOUSLY_ATTEMPTED","SUSPICIOUS_USER_BEHAVIOUR","SCREEN_DETECTED","AML_MATCH","ADDRESS_DOCUMENT_DOCUMENT_NOT_ISSUED_RECENTLY","ADDRESS_DOCUMENT_MISSING_NAME","ADDRESS_DOCUMENT_MISSING_ADDRESS","ADDRESS_DOCUMENT_UNRECOGNIZED_DOCUMENT","ADDRESS_DOCUMENT_NAME_VERIFICATION_FAILED","DATABASE_LOOKUP_ISSUE","THIRD_PARTY_API_FAILED","API_DATA_REQUIREMENTS_NOT_MET","WORKFLOW_CONFIG_ERROR","ID_WARNING","AML_WARNING","FRAUD_WARNING","ADDITIONAL_WARNING"],"type":"string","description":"Error code for programmatic handling. See documentation for complete list of error codes and their meanings.","example":"DOCUMENT_MISSING_BACK","isRequired":true,"uniqueKey":"verificationIssues.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable, actionable explanation","example":"Please upload clear photos of both the front and back of your ID.","isRequired":true,"uniqueKey":"verificationIssues.items.[INDEX].message","typeLabel":"string"},"timestamp":{"format":"date-time","type":"string","description":"When the issue was detected","example":"2023-10-01T12:00:00Z","isRequired":true,"uniqueKey":"verificationIssues.items.[INDEX].timestamp","typeLabel":"string\u003cdate-time>"}},"required":["code","message","timestamp"],"additionalProperties":false,"title":"Verification Issue","description":"Details about a specific verification issue blocking customer approval","uniqueKey":"verificationIssues.items.[INDEX]","typeLabel":"Verification Issue · object"},"description":"Current verification issues blocking customer approval. Only present for customers in NEEDS_ADDITIONAL_INFORMATION, UNDER_REVIEW, or REJECTED status.","example":[{"code":"DOCUMENT_MISSING_BACK","message":"Please upload clear photos of both the front and back of your ID.","timestamp":"2023-10-01T12:00:00Z"}],"uniqueKey":"verificationIssues","typeLabel":"Verification Issue · object[]"}},"required":["customerId","customerStatus","email","customerType","name","verificationLink","updatedAt","organizationId"],"additionalProperties":false,"title":"Get Customer Response","description":"Response schema for a customer retrieval request","uniqueKey":"","typeLabel":"Get Customer Response · object"},"examples":{"example1":{"title":"example1","value":{"customerId":"03b7030f-6da1-4d76-9352-cdebd82112c8","customerStatus":"ACTIVE","customerType":"INDIVIDUAL","name":"John Doe","email":"johndoe@example.com","verificationLink":"https://forms.fernhq.com/verify-customer/03b7030f-6da1-4d76-9352-cdebd82112c8","updatedAt":"2023-10-01T12:00:00Z","organizationId":"8469411c-48c1-4e26-a032-44688be9cb4b"}},"example2":{"title":"example2","value":{"customerId":"f47ac10b-58cc-4372-a567-0e02b2c3d479","customerStatus":"UNDER_REVIEW","customerType":"BUSINESS","name":"Acme Corp","email":"contact@acme.com","verificationLink":"https://forms.fernhq.com/verify-individual/f47ac10b-58cc-4372-a567-0e02b2c3d479","updatedAt":"2023-10-02T14:30:00Z","organizationId":"8469411c-48c1-4e26-a032-44688be9cb4b"}}},"exampleType":"examples"}},"exampleType":"examples"},"f51dcf7b-497e-47e4-83d1-971a24156fa6":{"description":"Bad Request","content":{"application/json":{"schema":{"description":"Bad Request","type":"object","properties":{"message":{"type":"string","description":"Human-readable error message","example":"Invalid input provided","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Error code for programmatic handling","example":"VALIDATION_ERROR","uniqueKey":"code","typeLabel":"string"},"details":{"description":"Additional error context","uniqueKey":"details","typeLabel":"any"}},"required":["message"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"example1":{"title":"example1","value":{"code":"BAD_REQUEST","message":"","statusCode":400}},"example2":{"title":"example2","value":{"code":"VALIDATION_ERROR","message":"Invalid body data","details":[{"path":[],"message":"","location":"body"}],"statusCode":400}}},"exampleType":"examples"}},"exampleType":"examples"},"281d89e3-1ca7-47eb-8e29-d251e1cbfc50":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Unauthorized","type":"object","properties":{"message":{"type":"string","description":"Human-readable error message","example":"Invalid input provided","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Error code for programmatic handling","example":"VALIDATION_ERROR","uniqueKey":"code","typeLabel":"string"},"details":{"description":"Additional error context","uniqueKey":"details","typeLabel":"any"}},"required":["message"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"code":"UNAUTHORIZED","message":"Missing API Key","statusCode":401},"examples":{"Example":{"title":"Example","value":{"code":"UNAUTHORIZED","message":"Missing API Key","statusCode":401}}},"exampleType":"examples"}},"exampleType":"examples"},"a48087f2-3c30-482e-8e30-52917bbf3ba1":{"description":"Forbidden","content":{"application/json":{"schema":{"description":"Forbidden","type":"object","properties":{"message":{"type":"string","description":"Human-readable error message","example":"Invalid input provided","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Error code for programmatic handling","example":"VALIDATION_ERROR","uniqueKey":"code","typeLabel":"string"},"details":{"description":"Additional error context","uniqueKey":"details","typeLabel":"any"}},"required":["message"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"code":"FORBIDDEN","message":"","statusCode":403},"examples":{"Example":{"title":"Example","value":{"code":"FORBIDDEN","message":"","statusCode":403}}},"exampleType":"examples"}},"exampleType":"examples"},"6a20af03-0fde-4ebb-9eae-38e88c00e53e":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found","type":"object","properties":{"message":{"type":"string","description":"Human-readable error message","example":"Invalid input provided","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Error code for programmatic handling","example":"VALIDATION_ERROR","uniqueKey":"code","typeLabel":"string"},"details":{"description":"Additional error context","uniqueKey":"details","typeLabel":"any"}},"required":["message"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"code":"NOT_FOUND","message":"Customer not found with id 9eb88b00-f04f-409b-9df7-7dcc9003bc35","statusCode":404},"examples":{"Example":{"title":"Example","value":{"code":"NOT_FOUND","message":"Customer not found with id 9eb88b00-f04f-409b-9df7-7dcc9003bc35","statusCode":404}}},"exampleType":"examples"}},"exampleType":"examples"},"4816dbbe-1c12-4e04-bc2b-e836a36cb59b":{"description":"Internal Server Error","content":{"application/json":{"schema":{"description":"Internal Server Error","type":"object","properties":{"message":{"type":"string","description":"Human-readable error message","example":"Invalid input provided","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Error code for programmatic handling","example":"VALIDATION_ERROR","uniqueKey":"code","typeLabel":"string"},"details":{"description":"Additional error context","uniqueKey":"details","typeLabel":"any"}},"required":["message"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"code":"INTERNAL_SERVER_ERROR","message":"INTERNAL_SERVER_ERROR","statusCode":500},"examples":{"Example":{"title":"Example","value":{"code":"INTERNAL_SERVER_ERROR","message":"INTERNAL_SERVER_ERROR","statusCode":500}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"94145c0a-bd1e-40cc-98ba-b1d672fbe835":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"To authenticate server-side requests","scopes":[]}}},"servers":{"2d601e0e-cd6f-46b1-99a3-ec1f1dba16f1":{"url":"https://api.fernhq.com","description":"API Server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"To authenticate server-side requests","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"To authenticate server-side requests","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"https://api.fernhq.com/json"},"subdomain":"fern-e3ce17d5","siteName":"Fern API Documentation","title":"Create customer - Fern API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-23T11:40:14.104Z","originalFileLocation":"api-reference/customers/create-customer.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Upon successful customer creation, a hosted KYC link requesting the required information to fill in will be generated. This may be distributed to your end-user for completion, or it can be completed on the customer\u0026#x27;s behalf by your team.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Fern API Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/fern-e3ce17d5/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/fern-e3ce17d5/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/fern-e3ce17d5/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/fern-e3ce17d5/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create customer - Fern API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Upon successful customer creation, a hosted KYC link requesting the required information to fill in will be generated. This may be distributed to your end-user for completion, or it can be completed on the customer\u0026#x27;s behalf by your team.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Fern API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.fernhq.com/api-reference/customers/create-customer\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://fern-e3ce17d5.mintlify.site/_mintlify/api/og/v2?division=Customers\u0026amp;title=Create+customer\u0026amp;description=Upon+successful+customer+creation%2C+a+hosted+KYC+link+requesting+the+required+information+to+fill+in+will+be+generated.+This+may+be+distributed+to+your+end-user+\u0026amp;theme=e424e93bdf26b63dfb726949\u0026amp;signature=3b2234e47c2a9e676953915f152bd112cd50ff86a9d9aa39ed1ba34047cffca5\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create customer - Fern API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Upon successful customer creation, a hosted KYC link requesting the required information to fill in will be generated. This may be distributed to your end-user for completion, or it can be completed on the customer\u0026#x27;s behalf by your team.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://fern-e3ce17d5.mintlify.site/_mintlify/api/og/v2?division=Customers\u0026amp;title=Create+customer\u0026amp;description=Upon+successful+customer+creation%2C+a+hosted+KYC+link+requesting+the+required+information+to+fill+in+will+be+generated.+This+may+be+distributed+to+your+end-user+\u0026amp;theme=e424e93bdf26b63dfb726949\u0026amp;signature=3b2234e47c2a9e676953915f152bd112cd50ff86a9d9aa39ed1ba34047cffca5\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"https://mintlify.s3.us-west-1.amazonaws.com/fern-e3ce17d5/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Fern API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#075E3F\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.fernhq.com/api-reference/customers/create-customer\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/customers/create-customer.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.fernhq.com/#organization\",\"name\":\"Fern API Documentation\",\"url\":\"https://docs.fernhq.com\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.fernhq.com#website\",\"name\":\"Fern API Documentation\",\"url\":\"https://docs.fernhq.com\",\"publisher\":{\"@id\":\"https://docs.fernhq.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.fernhq.com/api-reference/customers/create-customer#webpage\",\"url\":\"https://docs.fernhq.com/api-reference/customers/create-customer\",\"name\":\"Create customer\",\"description\":\"Upon successful customer creation, a hosted KYC link requesting the required information to fill in will be generated. This may be distributed to your end-user for completion, or it can be completed on the customer's behalf by your team.\",\"dateModified\":\"2026-01-23T11:40:14.104Z\",\"isPartOf\":{\"@id\":\"https://docs.fernhq.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.fernhq.com/api-reference/customers/create-customer#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.fernhq.com/api-reference/customers/create-customer#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Customers\",\"item\":\"https://docs.fernhq.com/api-reference/customers/list-customers\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create customer\",\"item\":\"https://docs.fernhq.com/api-reference/customers/create-customer\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.fernhq.com/api-reference/customers/create-customer#apireference\",\"headline\":\"Create customer\",\"name\":\"Create customer\",\"description\":\"Upon successful customer creation, a hosted KYC link requesting the required information to fill in will be generated. This may be distributed to your end-user for completion, or it can be completed on the customer's behalf by your team.\",\"url\":\"https://docs.fernhq.com/api-reference/customers/create-customer\",\"mainEntityOfPage\":{\"@id\":\"https://docs.fernhq.com/api-reference/customers/create-customer#webpage\"},\"dateModified\":\"2026-01-23T11:40:14.104Z\",\"publisher\":{\"@id\":\"https://docs.fernhq.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.fernhq.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Fern API Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Fern API Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/customers/create-customer.md","siteName":"Fern API Documentation","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/getting-started/introduction"}]},{"anchor":"Guides","icon":"book","pages":[{"title":"Guides","href":"/guides/create-and-verify-customers/api-verification"}]},{"anchor":"API Reference","icon":"square-terminal","groups":[{"group":"Customers","pages":[{"title":"List customers","description":"List all customers with cursor-based pagination","deprecated":null,"version":null,"openapi":"https://api.fernhq.com/json get /customers","href":"/api-reference/customers/list-customers"},{"title":"Create customer","deprecated":null,"version":null,"openapi":"https://api.fernhq.com/json post /customers","href":"/api-reference/customers/create-customer"},{"title":"Get customer","description":"Get details about a customer","deprecated":null,"version":null,"openapi":"https://api.fernhq.com/json get /customers/{customerId}","href":"/api-reference/customers/get-customer"},{"title":"Update customer KYC data","deprecated":null,"version":null,"openapi":"https://api.fernhq.com/json patch /customers/{customerId}","href":"/api-reference/customers/update-customer-kyc-data"}]},{"group":"Transactions","pages":[{"title":"List transactions","deprecated":null,"version":null,"openapi":"https://api.fernhq.com/json get /transactions","href":"/api-reference/transactions/list-transactions"},{"title":"Create transaction","deprecated":null,"version":null,"openapi":"https://api.fernhq.com/json post /transactions","href":"/api-reference/transactions/create-transaction"},{"title":"Get transaction","deprecated":null,"version":null,"openapi":"https://api.fernhq.com/json get /transactions/{transactionId}","href":"/api-reference/transactions/get-transaction"},{"title":"Cancel transaction","deprecated":null,"version":null,"openapi":"https://api.fernhq.com/json delete /transactions/{transactionId}","href":"/api-reference/transactions/cancel-transaction"}]},{"group":"Quotes","pages":[{"title":"Create quote","deprecated":null,"version":null,"openapi":"https://api.fernhq.com/json post /quotes","href":"/api-reference/quotes/create-quote"}]},{"group":"Payment Accounts","pages":[{"title":"List payment accounts","deprecated":null,"version":null,"openapi":"https://api.fernhq.com/json get /payment-accounts","href":"/api-reference/payment-accounts/list-payment-accounts"},{"title":"Create payment account","deprecated":null,"version":null,"openapi":"https://api.fernhq.com/json post /payment-accounts","href":"/api-reference/payment-accounts/create-payment-account"},{"title":"Get payment account","deprecated":null,"version":null,"openapi":"https://api.fernhq.com/json get /payment-accounts/{paymentAccountId}","href":"/api-reference/payment-accounts/get-payment-account"},{"title":"Delete payment account","deprecated":null,"version":null,"openapi":"https://api.fernhq.com/json delete /payment-accounts/{paymentAccountId}","href":"/api-reference/payment-accounts/delete-payment-account"},{"title":"Get payment account balance","deprecated":null,"version":null,"openapi":"https://api.fernhq.com/json get /payment-accounts/{paymentAccountId}/balance","href":"/api-reference/payment-accounts/get-payment-account-balance"},{"title":"Get exchange rate","deprecated":null,"version":null,"openapi":"https://api.fernhq.com/json get /exchange-rates","href":"/api-reference/payment-accounts/get-exchange-rate"}]},{"group":"Automation Rules","pages":[{"title":"List automation rules","deprecated":null,"version":null,"openapi":"https://api.fernhq.com/json get /automation-rules","href":"/api-reference/automation-rules/list-automation-rules"},{"title":"Create automation rule","deprecated":null,"version":null,"openapi":"https://api.fernhq.com/json post /automation-rules","href":"/api-reference/automation-rules/create-automation-rule"},{"title":"Get automation rule by ID","deprecated":null,"version":null,"openapi":"https://api.fernhq.com/json get /automation-rules/{ruleId}","href":"/api-reference/automation-rules/get-automation-rule-by-id"},{"title":"Update automation rule","deprecated":null,"version":null,"openapi":"https://api.fernhq.com/json put /automation-rules/{ruleId}","href":"/api-reference/automation-rules/update-automation-rule"},{"title":"Delete automation rule","deprecated":null,"version":null,"openapi":"https://api.fernhq.com/json delete /automation-rules/{ruleId}","href":"/api-reference/automation-rules/delete-automation-rule"}]},{"group":"Webhooks","pages":[{"title":"Customer created webhook","version":null,"deprecated":null,"openapi":"https://api.fernhq.com/json webhook customer.created","href":"/api-reference/webhooks/customer-created-webhook"},{"title":"Customer updated webhook","version":null,"deprecated":null,"openapi":"https://api.fernhq.com/json webhook customer.updated","href":"/api-reference/webhooks/customer-updated-webhook"},{"title":"Transaction created webhook","version":null,"deprecated":null,"openapi":"https://api.fernhq.com/json webhook transaction.created","href":"/api-reference/webhooks/transaction-created-webhook"},{"title":"Transaction updated webhook","version":null,"deprecated":null,"openapi":"https://api.fernhq.com/json webhook transaction.updated","href":"/api-reference/webhooks/transaction-updated-webhook"},{"title":"Payment account created webhook","version":null,"deprecated":null,"openapi":"https://api.fernhq.com/json webhook payment_account.created","href":"/api-reference/webhooks/payment-account-created-webhook"},{"title":"Payment account deleted webhook","version":null,"deprecated":null,"openapi":"https://api.fernhq.com/json webhook payment_account.deleted","href":"/api-reference/webhooks/payment-account-deleted-webhook"}]}]},{"anchor":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]},{"anchor":"Support","icon":"circle-question","pages":[{"title":"Support","href":"/help-and-support"}]}]},"basePath":"","title":"Create customer - Fern API Documentation","buildId":"dpl_GRSyrvXT6FFTpZZTGz5iZPp3D2zE","deploymentId":"dpl_GRSyrvXT6FFTpZZTGz5iZPp3D2zE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BFmjTMeT.js","utils-BWr-sjpP.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-LafIDf0N.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-MJNzuxek.js","snippetPresets-DPZEtUvW.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DQ2UhGIs.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DUUJTUkE.js","shallow-BTf5bw35.js","getApiPlaygroundDisplay-h2POYYOO.js","CodeSnippet-C4qEftRe.js","CodeSnippets-CsSrOqMC.js","Page-CWFqNdGh.js","getPastedJson-DU6W6y78.js","icon-2ZYNQ78y.js","MethodPill-BMXJzYMm.js","DuplicateIcon-DNjdEpYZ.js","createIcon-WdPVhKxl.js","DynamicMarkdown-Z_y464fM.js","SectionHeading-Bcrd8azU.js","axios-vUo_bRtp.js","Markdown-BnvucbFu.js","dist-D7YyC486.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-D1I8TPjt.js"]}