Account
Subscribe to webhook events for connected account status changes.
The following webhook events are available for your Connected Accounts integration.
| Event | Description |
|---|---|
| account.active | Account is active. |
| account.connected | Account connected to another account. |
| account.suspended | Account verification unsuccessful. |
| account.action_required | Account requires further action to proceed with verification. |
| account.submitted | Account is submitted. |
Payload examples
account.active, account.suspended
Payload of webhook events:
- account.active
- account.suspended
JSON
1{2 "accountId":"acct_TOslkS7-MnyXlQuV8Lb4og",3 "data":Object{...},4 "id":"86b69f91-06f0-3fe8-8faf-4de58954ca8e",5 "name":"account.active"6}
data is the response body of Get account by ID API
JSON
1{2 "accountDetails": {3 "authorisedPersonDetails": {4 "attachments": {5 "identityFiles": [6 {7 "description": "string",8 "fileId": "string",9 "tag": "DRIVERS_LICENSE_FRONT"10 }11 ]12 },13 "email": "[email protected]",14 "fillingAs": "string",15 "firstName": "Alice",16 "firstNameEnglish": "Alice",17 "identificationNumber": "CKKK784512",18 "lastName": "Smith",19 "lastNameEnglish": "Smith",20 "nationality": "HK"21 },22 "beneficialOwners": [23 {24 "address": {25 "addressLine1": "200 Collins Street",26 "addressLine2": "200 Collins Street",27 "countryCode": "AU",28 "postcode": "3000",29 "state": "VIC",30 "suburb": "Melbourne"31 },32 "attachments": {33 "identityFiles": [34 {35 "description": "string",36 "fileId": "string",37 "tag": "DRIVERS_LICENSE_FRONT"38 }39 ]40 },41 "dateOfBirth": "1980-10-10",42 "firstName": "John",43 "firstNameEnglish": "Alice",44 "identificationNumber": "AAA5417287BB",45 "identificationType": "personalId",46 "lastName": "Smith",47 "lastNameEnglish": "Smith",48 "nationality": "CN"49 }50 ],51 "businessDetails": {52 "address": {53 "addressLine1": "200 Collins Street",54 "addressLine2": "200 Collins Street",55 "countryCode": "AU",56 "postcode": "3000",57 "state": "VIC",58 "suburb": "Melbourne"59 },60 "addressEnglish": {61 "addressLine1": "200 Collins Street",62 "addressLine2": "200 Collins Street",63 "countryCode": "AU",64 "postcode": "3000",65 "state": "VIC",66 "suburb": "Melbourne"67 },68 "asTrustee": true,69 "attachments": {70 "businessDocuments": [71 {72 "description": "string",73 "fileId": "string",74 "tag": "BUSINESS_LICENSE"75 }76 ]77 },78 "businessAddress": {79 "addressLine1": "200 Collins Street",80 "addressLine2": "200 Collins Street",81 "countryCode": "AU",82 "postcode": "3000",83 "state": "VIC",84 "suburb": "Melbourne"85 },86 "businessName": "Swift Concrete Pty Ltd",87 "businessNameEnglish": "Swift Concrete Pty Ltd",88 "businessRegistrationNumber": "A1098762872",89 "businessStructure": "COMPANY",90 "contactNumber": "6457892324",91 "descriptionOfGoodsOrServices": "string",92 "descriptionOfIndustry": "string",93 "industryCategory": "Financial Services and Products",94 "industryCategoryLevel3": "Mortgage broker and dealers",95 "industrySubCategory": "Lending",96 "operatingCountry": [97 "US",98 "AU"99 ],100 "purpose": "string",101 "trustName": "name",102 "url": "http://www.your_company.com",103 "vatNumbers": [104 {105 "countryCode": "UK",106 "vatNumber": "0000"107 }108 ]109 },110 "directorDetails": [111 {112 "address": {113 "addressLine1": "200 Collins Street",114 "addressLine2": "200 Collins Street",115 "countryCode": "AU",116 "postcode": "3000",117 "state": "VIC",118 "suburb": "Melbourne"119 },120 "attachments": {121 "identityFiles": [122 {123 "description": "string",124 "fileId": "string",125 "tag": "DRIVERS_LICENSE_FRONT"126 }127 ]128 },129 "dateOfBirth": "1980-10-10",130 "firstName": "Alice",131 "firstNameEnglish": "Alice",132 "identificationNumber": "RRHK784512",133 "identificationType": "personalId",134 "lastName": "Smith",135 "lastNameEnglish": "Smith",136 "nationality": "HK"137 }138 ],139 "individualDetails": {140 "address": {141 "addressLine1": "200 Collins Street",142 "addressLine2": "200 Collins Street",143 "countryCode": "AU",144 "postcode": "3000",145 "state": "VIC",146 "suburb": "Melbourne"147 },148 "addressEnglish": {149 "addressLine1": "200 Collins Street",150 "addressLine2": "200 Collins Street",151 "countryCode": "AU",152 "postcode": "3000",153 "state": "VIC",154 "suburb": "Melbourne"155 },156 "attachments": {157 "individualDocuments": [158 {159 "description": "string",160 "fileId": "string",161 "tag": "DRIVERS_LICENSE_FRONT"162 }163 ]164 },165 "dateOfBirth": "1970-11-28",166 "firstName": "Alice",167 "firstNameEnglish": "Alice",168 "lastName": "Smith",169 "lastNameEnglish": "Smith",170 "middleName": "Benedict",171 "nationality": "HK",172 "photoFileId": "string",173 "primaryIdentification": {174 "driversLicense": {175 "backFileId": "string",176 "effectiveAt": "2020-11-01",177 "expireAt": "2040-11-01",178 "frontFileId": "string",179 "gender": "F",180 "issuingState": "VIC",181 "licenseNumber": "6275046",182 "version": "string"183 },184 "identificationType": "PASSPORT",185 "issuingCountryCode": "AU",186 "medicareCard": {187 "backFileId": "string",188 "cardNumber": "3395653571",189 "color": "GREEN",190 "effectiveAt": "2020-11-01",191 "expireAt": "2040-11-01",192 "frontFileId": "string",193 "referenceNumber": "string"194 },195 "passport": {196 "effectiveAt": "2020-11-01",197 "expireAt": "2040-11-01",198 "frontFileId": "string",199 "mrzLine1": "P<UTOERIKSSON<<ANNA<MARIA<<<<<<<<<<<<<<<<<<<",200 "mrzLine2": "L898902C<3UTO6908061F9406236ZE184226B<<<<<14",201 "passportNumber": "4107306240"202 },203 "personalId": {204 "backFileId": "string",205 "effectiveAt": "2020-11-01",206 "expireAt": "2040-11-01",207 "frontFileId": "string",208 "idNumber": "string"209 }210 },211 "secondaryIdentification": {212 "driversLicense": {213 "backFileId": "string",214 "effectiveAt": "2020-11-01",215 "expireAt": "2040-11-01",216 "frontFileId": "string",217 "gender": "F",218 "issuingState": "VIC",219 "licenseNumber": "6275046",220 "version": "string"221 },222 "identificationType": "PASSPORT",223 "issuingCountryCode": "AU",224 "medicareCard": {225 "backFileId": "string",226 "cardNumber": "3395653571",227 "color": "GREEN",228 "effectiveAt": "2020-11-01",229 "expireAt": "2040-11-01",230 "frontFileId": "string",231 "referenceNumber": "string"232 },233 "passport": {234 "effectiveAt": "2020-11-01",235 "expireAt": "2040-11-01",236 "frontFileId": "string",237 "mrzLine1": "P<UTOERIKSSON<<ANNA<MARIA<<<<<<<<<<<<<<<<<<<",238 "mrzLine2": "L898902C<3UTO6908061F9406236ZE184226B<<<<<14",239 "passportNumber": "4107306240"240 },241 "personalId": {242 "backFileId": "string",243 "effectiveAt": "2020-11-01",244 "expireAt": "2040-11-01",245 "frontFileId": "string",246 "idNumber": "string"247 }248 },249 "userIdOnPlatform": "string"250 },251 "legalEntityType": "INDIVIDUAL",252 "legalRepDetails": {253 "address": {254 "addressLine1": "200 Collins Street",255 "addressLine2": "200 Collins Street",256 "countryCode": "AU",257 "postcode": "3000",258 "state": "VIC",259 "suburb": "Melbourne"260 },261 "attachments": {262 "identityFiles": [263 {264 "description": "string",265 "fileId": "string",266 "tag": "DRIVERS_LICENSE_FRONT"267 }268 ]269 },270 "dateOfBirth": "1980-10-10",271 "firstName": "Alice",272 "firstNameEnglish": "Alice",273 "identificationNumber": "RRHK784512",274 "identificationType": "personalId",275 "lastName": "Smith",276 "lastNameEnglish": "Smith",277 "nationality": "HK"278 },279 "trusteeDetails": {280 "businessDetails": {281 "address": {282 "addressLine1": "200 Collins Street",283 "addressLine2": "200 Collins Street",284 "countryCode": "AU",285 "postcode": "3000",286 "state": "VIC",287 "suburb": "Melbourne"288 },289 "addressEnglish": {290 "addressLine1": "200 Collins Street",291 "addressLine2": "200 Collins Street",292 "countryCode": "AU",293 "postcode": "3000",294 "state": "VIC",295 "suburb": "Melbourne"296 },297 "attachments": {298 "businessDocuments": [299 {300 "description": "string",301 "fileId": "string",302 "tag": "BUSINESS_LICENSE"303 }304 ]305 },306 "beneficialOwners": [307 {308 "address": {309 "addressLine1": "200 Collins Street",310 "addressLine2": "200 Collins Street",311 "countryCode": "AU",312 "postcode": "3000",313 "state": "VIC",314 "suburb": "Melbourne"315 },316 "attachments": {317 "identityFiles": [318 {319 "description": "string",320 "fileId": "string",321 "tag": "DRIVERS_LICENSE_FRONT"322 }323 ]324 },325 "dateOfBirth": "1980-10-10",326 "firstName": "John",327 "firstNameEnglish": "Alice",328 "identificationNumber": "AAA5417287BB",329 "identificationType": "personalId",330 "lastName": "Smith",331 "lastNameEnglish": "Smith",332 "nationality": "CN"333 }334 ],335 "businessName": "Swift Concrete Pty Ltd",336 "businessNameEnglish": "Swift Concrete Pty Ltd",337 "businessRegistrationNumber": "A1098762872",338 "businessStructure": "COMPANY",339 "contactNumber": "6457892324",340 "descriptionOfGoodsOrServices": "string",341 "descriptionOfIndustry": "string",342 "directorDetails": [343 {344 "address": {345 "addressLine1": "200 Collins Street",346 "addressLine2": "200 Collins Street",347 "countryCode": "AU",348 "postcode": "3000",349 "state": "VIC",350 "suburb": "Melbourne"351 },352 "attachments": {353 "identityFiles": [354 {355 "description": "string",356 "fileId": "string",357 "tag": "DRIVERS_LICENSE_FRONT"358 }359 ]360 },361 "dateOfBirth": "1980-10-10",362 "firstName": "Alice",363 "firstNameEnglish": "Alice",364 "identificationNumber": "RRHK784512",365 "identificationType": "personalId",366 "lastName": "Smith",367 "lastNameEnglish": "Smith",368 "nationality": "HK"369 }370 ],371 "industryCategory": "Financial Services and Products",372 "industryCategoryLevel3": "Mortgage broker and dealers",373 "industrySubCategory": "Lending",374 "operatingCountry": [375 "US",376 "AU"377 ],378 "url": "http://www.your_company.com"379 },380 "individualDetails": [381 {382 "address": {383 "addressLine1": "200 Collins Street",384 "addressLine2": "200 Collins Street",385 "countryCode": "AU",386 "postcode": "3000",387 "state": "VIC",388 "suburb": "Melbourne"389 },390 "attachments": {391 "identityFiles": [392 {393 "description": "string",394 "fileId": "string",395 "tag": "DRIVERS_LICENSE_FRONT"396 }397 ]398 },399 "dateOfBirth": "1980-10-10",400 "firstName": "John",401 "firstNameEnglish": "Alice",402 "identificationNumber": "AAA5417287BB",403 "identificationType": "personalId",404 "lastName": "Smith",405 "lastNameEnglish": "Smith",406 "nationality": "CN"407 }408 ],409 "legalEntityType": "INDIVIDUAL"410 }411 },412 "accountUsage": {413 "cardUsage": [414 "string"415 ],416 "collectionCountryCodes": [417 "US",418 "AU"419 ],420 "collectionFrom": "Self top up, payment gateway, marketplaces, etc.",421 "expectedMonthlyTransactionVolume": {422 "amount": "50000"423 },424 "payoutCountryCodes": [425 "HK",426 "CN"427 ],428 "payoutTo": "Self top up, payment gateway, marketplaces, etc."429 },430 "createdAt": "string",431 "customerAgreements": {432 "agreedToDataUsage": true,433 "agreedToTermsAndConditions": true,434 "optInForMarketing": true435 },436 "id": "string",437 "identifier": "string",438 "metadata": {439 "{fieldPath}": {440 }441 },442 "nextAction": {443 "type": "string"444 },445 "primaryContact": {446 "email": "[email protected]",447 "mobile": "string"448 },449 "requirements": {450 "agreementToTermsAndConditionsRequired": {451 "endpoint": "string",452 "message": "Account has passed review. To activate the account, please agree to the terms and conditions by calling the endpoint.",453 "method": "POST"454 },455 "photoFileIdRequired": {456 "message": "Identity verification failed",457 "photoFileId": "Njg3MzkzNWMtMmNlNC00NDM3L="458 },459 "primaryIdentificationRequired": [460 {461 "backFileId": "Njg3MzkzNWMtMmNlNC00NDM3L=",462 "firstName": "Alice",463 "frontFileId": "Njg3MzkzNWMtMmNlNC00NDM3L=",464 "lastName": "Smith",465 "message": "Identity verification failed",466 "middleName": "Benedict"467 }468 ],469 "secondaryIdentificationRequired": [470 {471 "backFileId": "Njg3MzkzNWMtMmNlNC00NDM3L=",472 "firstName": "Alice",473 "frontFileId": "Njg3MzkzNWMtMmNlNC00NDM3L=",474 "lastName": "Smith",475 "message": "Identity verification failed",476 "middleName": "Benedict"477 }478 ]479 },480 "status": "ACTIVE"481}
account.connected
Relevant webhook events:
- account.connected
JSON
1{2 "accountId":"acct_IDSCMmzqMCeKRFcgwbtAdQ",3 "data":{4 "connectedAccountId":"acct_c9njGfy5PQOwfLeKGWox0A",5 "connectedAccountIdentifier":"12345",6 "connectedAccountName":"Ludwig Zamenhof",7 "createdAt":"2019-06-19T06:14:58+0000",8 "connectedAccountStatus":"ACTIVE",9 "platformAccountId":"acct_IDSCMmzqMCeKRFcgwbtAdQ",10 "platformName":"Wishcom Shanghai"11 },12 "id":"45a6d9c3-bdcd-3bbf-b592-10f287a87ccd",13 "name":"account.connected"14}
account.action_required
Relevant webhook events:
- account.action_required
JSON
1{2 "accountId":"acct_IDSCMmzqMCeKRFcgwbtAdQ",3 "data":{4 "agreedToTermsAndConditionsRequired": {5 "endpoint": "app/v1/accounts/acct_GyxgVwu_NhGTWOgXZHwLBg/terms_and_conditions/agree",6 "method": "POST",7 "message": "Account has passed review. To activate the account, please agree to the terms and conditions by calling the endpoint"8 }9 },10 "id":"45a6d9c3-bdcd-3bbf-b592-10f287a87ccd",11 "name":"account.action_required"12}
account.submitted
Relevant webhook events:
- account.submitted
JSON
1{2 "id": "evt_h-qg-qLaNaGiqFHSlD8lHg",3 "name": "account.submitted",4 "account_id": "acct_tl429bI0MCelEyQfAMtnGw",5 "data": {},6 "created_at": "2023-07-13T10:51:25+0000"7}
Was this page helpful?