{"openapi":"3.1.0","info":{"title":"Beneficiary Webhooks API","description":"API documentation with separate webhooks for every beneficiary verification status combination.","version":"1.0.0"},"webhooks":{"beneficiaryStatusChange.approved":{"post":{"operationId":"beneficiaryStatusChange_approved","tags":["Beneficiary Status Change"],"x-atlas-webhook":true,"summary":"Approved","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BeneficiaryStatusChangeEvent"},{"properties":{"payload":{"properties":{"status":{"type":"string","enum":["approved"]}}}}}]},"examples":{"beneficiary_approved":{"summary":"Beneficiary Status Change — verification approved","value":{"companyId":"1001","eventType":"BENEFICIARY_STATUS_CHANGE","createdAt":"2026-10-12T09:15:30.123Z","metadata":{"originTime":"2026-10-12T09:15:30.101Z","retryAttempts":0,"nextAttemptTime":null,"userRecordId":"5001","companyId":"1001"},"payload":{"id":100001,"accountNumber":"ACCT-123456789","bankName":"First Mock Bank of Development","beneficiaryAddress":"123 Fake Street","beneficiaryCity":"Metropolis","beneficiaryCompanyName":null,"beneficiaryCountryCode":"US","beneficiaryEntityType":"individual","beneficiaryPostcode":"12345","beneficiaryEmail":"john.doe@example.com","country":"United States","reference":"REF-MOCK-APP-001","beneficiaryFirstName":"John","beneficiaryLastName":"Doe","nationalId":"NID-000-0000","currency":"USD","clientReference":"CLIENT-REF-APP-123","status":"approved"},"type":"BENEFICIARY_STATUS_CHANGE"}}}}}},"responses":{"200":{"description":"Acknowledged successfully."}}}},"beneficiaryStatusChange.pending":{"post":{"operationId":"beneficiaryStatusChange_pending","tags":["Beneficiary Status Change"],"x-atlas-webhook":true,"summary":"Pending","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BeneficiaryStatusChangeEvent"},{"properties":{"payload":{"properties":{"status":{"type":"string","enum":["pending"]}}}}}]},"examples":{"beneficiary_pending":{"summary":"Beneficiary Status Change — verification pending manual review","value":{"companyId":"1002","eventType":"BENEFICIARY_STATUS_CHANGE","createdAt":"2026-10-12T10:02:11.456Z","metadata":{"originTime":"2026-10-12T10:02:11.430Z","retryAttempts":0,"nextAttemptTime":null,"userRecordId":"5002","companyId":"1002"},"payload":{"id":100002,"accountNumber":"ACCT-987654321","bankName":"Global Sandbox Bank","beneficiaryAddress":null,"beneficiaryCity":null,"beneficiaryCompanyName":"Acme Corporation","beneficiaryCountryCode":"CA","beneficiaryEntityType":"company","beneficiaryPostcode":null,"beneficiaryEmail":null,"country":"Canada","reference":"REF-MOCK-PEN-002","beneficiaryFirstName":null,"beneficiaryLastName":null,"nationalId":"CORP-ID-9999","currency":"CAD","clientReference":null,"status":"pending"},"type":"BENEFICIARY_STATUS_CHANGE"}}}}}},"responses":{"200":{"description":"Acknowledged successfully."}}}},"beneficiaryStatusChange.rejected":{"post":{"operationId":"beneficiaryStatusChange_rejected","tags":["Beneficiary Status Change"],"x-atlas-webhook":true,"summary":"Rejected","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BeneficiaryStatusChangeEvent"},{"properties":{"payload":{"properties":{"status":{"type":"string","enum":["rejected"]}}}}}]},"examples":{"beneficiary_rejected":{"summary":"Beneficiary Status Change — verification rejected","value":{"companyId":"1003","eventType":"BENEFICIARY_STATUS_CHANGE","createdAt":"2026-10-12T11:47:05.789Z","metadata":{"originTime":"2026-10-12T11:47:05.760Z","retryAttempts":0,"nextAttemptTime":null,"userRecordId":"5003","companyId":"1003"},"payload":{"id":100003,"accountNumber":"ACCT-000000000","bankName":"Null Island Credit Union","beneficiaryAddress":"404 Not Found Avenue","beneficiaryCity":"Testville","beneficiaryCompanyName":null,"beneficiaryCountryCode":"GB","beneficiaryEntityType":"individual","beneficiaryPostcode":"TE5 7ER","beneficiaryEmail":null,"country":"United Kingdom","reference":"REF-MOCK-REJ-003","beneficiaryFirstName":"Jane","beneficiaryLastName":"Smith","nationalId":"NID-999-9999","currency":"GBP","clientReference":"CLIENT-REF-REJ-456","status":"rejected"},"type":"BENEFICIARY_STATUS_CHANGE"}}}}}},"responses":{"200":{"description":"Acknowledged successfully."}}}}},"components":{"schemas":{"BeneficiaryStatusChangeEvent":{"type":"object","required":["companyId","eventType","createdAt","metadata","payload","type"],"properties":{"companyId":{"type":"string","description":"Company the beneficiary belongs to."},"eventType":{"type":"string","enum":["BENEFICIARY_STATUS_CHANGE"]},"createdAt":{"type":"string","format":"date-time"},"metadata":{"$ref":"#/components/schemas/BeneficiaryStatusChangeMetadata"},"payload":{"$ref":"#/components/schemas/BeneficiaryStatusChangeBase"},"type":{"type":"string","enum":["BENEFICIARY_STATUS_CHANGE"]}}},"BeneficiaryStatusChangeMetadata":{"type":"object","properties":{"originTime":{"type":"string","format":"date-time"},"retryAttempts":{"type":"integer"},"nextAttemptTime":{"type":"string","format":"date-time","nullable":true},"userRecordId":{"type":"string","nullable":true},"companyId":{"type":"string","nullable":true}}},"BeneficiaryStatusChangeBase":{"type":"object","required":["id","accountNumber","bankName","beneficiaryEntityType","country","reference","nationalId","status"],"properties":{"id":{"type":"integer","nullable":true},"accountNumber":{"type":"string"},"bankName":{"type":"string"},"beneficiaryAddress":{"type":"string","nullable":true},"beneficiaryCity":{"type":"string","nullable":true},"beneficiaryCountryCode":{"type":"string","nullable":true},"beneficiaryEntityType":{"type":"string","enum":["individual","company"]},"beneficiaryPostcode":{"type":"string","nullable":true},"beneficiaryFirstName":{"type":"string","nullable":true},"beneficiaryLastName":{"type":"string","nullable":true},"beneficiaryCompanyName":{"type":"string","nullable":true},"beneficiaryEmail":{"type":"string","format":"email","nullable":true},"country":{"type":"string"},"reference":{"type":"string"},"nationalId":{"type":"string"},"currency":{"type":"string","nullable":true},"clientReference":{"type":"string","nullable":true},"status":{"type":"string","enum":["approved","pending","rejected"]}}}}},"paths":{}}