Deliver account verification outcome

This operation is asynchronous. It communicates the outcome of an outboundAccountVerification operation.

The outbound account verification report operation can be called to deliver the outcome of a previously requested account verification request.

Scheme	Applicable	Function Enabled
ZA_AVS	✓	Verifying account information

Request

header Parameters

traceparent	string (traceparent) ^[A-Fa-f0-9]{2}\-[A-Fa-f0-9]{32}\-[A-Fa-f0-9]... A value used to trace an HTTP message within an Electrum Regulated Payments implementation. This field must be set as per the `traceparent` element defined in the (W3C Trace Context Level 2 specification (V2))[https://www.w3.org/TR/trace-context-2/].
tracestate	string (tracestate) ^[A-Za-z0-9=, _\*/@]{0,1024}$ A value used to provide context to an HTTP message as it is traced within an Electrum Regulated Payments implementation. This field must be set as per the `traceparent` element defined in the (W3C Trace Context Level 2 specification (V2))[https://www.w3.org/TR/trace-context-2/].

Request Body schema: application/json

required	object (MessageIdentifiers) Holds a point-to-point unique message identification string as well as a message's creation date time.
	object (SupplementaryData) A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.
required	object (TransactionIdentifiers) Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.
required	object (Party) This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.
required	object (Party) This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.
	object (Party) This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.
	object (InstitutionIdentification)
	object (Assignment)
	object (MessageIdentifiers) Holds a point-to-point unique message identification string as well as a message's creation date time.
	object (Verification)
	object (VerificationReport)
schema required	string Value: "AccountVerificationResponse"
	object (Status)

Responses

202

Accepted. RFC9110 - 202

400

Bad request. RFC9110 - 400

401

Unauthorized. RFC9110 - 401

403

Forbidden. RFC9110 - 403

405

Method not allowed. RFC9110 - 405

422

Unprocessable content. RFC9110 - 422

429

Too Many Requests. RFC6585 - 429

500

Internal server error. RFC9110 - 500

503

Service unavailable. RFC9110 - 503

post/accounts/outbound/account-verification-report

Request samples

application/json

{"schema": "AccountVerificationResponse",
"messageIdentifiers": {"messageIdentification": "9fd51c1234ba4819bbheyde296a68e1da",
"creationDateTime": "2022-05-04T03:22:11Z"
},
"originalMessageIdentifiers": {"messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
"creationDateTime": "2022-05-04T03:02:01Z"
},
"transactionIdentifiers": {"endToEndIdentification": "6249118655591098",
"transactionIdentification": "RRN000000001",
"uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa"
},
"creator": {"legalName": "Zamazing Bank Inc",
"identification": {"schema": "ORGANISATION",
"identifiers": [{"schema": "BIC",
"BIC": "ZY8PEG0L"
},
{"schema": "OTHER",
"identification": "ZamazingBankClearingID",
"scheme": {"schema": "CODE",
"value": "CHID"
}
}
]
}
},
"firstAgent": {"bicfi": "RY8PEG0L",
"memberId": "ZamazingBankId",
"name": "Zamazing Bank Inc",
"branch": {"identification": "210514",
"name": "XYZ Knysna",
"address": {"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": ["16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
}
}
},
"assigner": {"legalName": "Zamazing Bank Inc",
"identification": {"schema": "ORGANISATION",
"identifiers": [{"schema": "BIC",
"BIC": "ZY8PEG0L"
},
{"schema": "OTHER",
"identification": "ZamazingBankClearingID",
"scheme": {"schema": "CODE",
"value": "CHID"
}
}
]
}
},
"assignee": {"legalName": "Amazing Bank Inc",
"identification": {"schema": "ORGANISATION",
"identifiers": [{"schema": "BIC",
"BIC": "RY8PEG0L"
},
{"schema": "OTHER",
"identification": "AmazingBankClearingID",
"scheme": {"schema": "CODE",
"value": "CHID"
}
}
]
}
},
"originalVerification": {"identification": "e21a36adc5ab4b70a3f9952d743eaeaa",
"party": {"legalName": "Joshua Paul du Plessis",
"address": {"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": ["16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
},
"contactDetails": {"phoneNumber": "+27-214620000",
"mobileNumber": "+27-8230000000",
"emailAddress": "josh.du.plessis@electrum.com"
},
"countryOfResidence": "ZA",
"identification": {"schema": "PERSON",
"identifiers": [{"identification": "90001236549870",
"scheme": {"schema": "CODE",
"value": "NIDN"
},
"issuer": "Dept of Home Affairs"
}
]
}
},
"account": {"identification": {"schema": "GENERIC",
"scheme": {"schema": "CODE",
"value": "BBAN"
},
"issuer": "Amazing Bank",
"value": 60091645492
},
"type": {"schema": "CODE",
"value": "CACC"
},
"currency": "ZAR"
},
"agent": {"branch": {"identification": "210514",
"name": "ABC Plettenberg Bay",
"address": {"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": ["16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
}
}
},
"schemeVerificationData": {"schema": "ZA_AVS",
"checkDebitsAllowed": "true",
"checkCreditsAllowed": "true",
"checkOlderThanThreeMonths": "true",
"initials": "JP",
"lastName": "du Plessis"
}
},
"originalAssignment": {"creator": {"legalName": "Amazing Bank Inc",
"identification": {"schema": "ORGANISATION",
"identifiers": [{"schema": "BIC",
"BIC": "RY8PEG0L"
},
{"schema": "OTHER",
"identification": "AmazingBankClearingID",
"scheme": {"schema": "CODE",
"value": "CHID"
}
}
]
}
},
"firstAgent": {"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {"identification": "210514",
"name": "ABC Plettenberg Bay",
"address": {"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": ["16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
}
}
},
"assigner": {"legalName": "Amazing Bank Inc",
"identification": {"schema": "ORGANISATION",
"identifiers": [{"schema": "BIC",
"BIC": "RY8PEG0L"
},
{"schema": "OTHER",
"identification": "AmazingBankClearingID",
"scheme": {"schema": "CODE",
"value": "CHID"
}
}
]
}
},
"assignee": {"legalName": "Zamazing Bank Inc",
"identification": {"schema": "ORGANISATION",
"identifiers": [{"schema": "BIC",
"BIC": "ZY8PEG0L"
},
{"schema": "OTHER",
"identification": "ZamazingBankClearingID",
"scheme": {"schema": "CODE",
"value": "CHID"
}
}
]
}
}
},
"status": {"outcome": "APPROVED",
"reasonInfo": [{"reason": {"schema": "CODE",
"value": "ACCC"
}
}
]
},
"report": {"originalIdentification": "e21a36adc5ab4b70a3f9952d743eaeaa",
"outcome": {"schema": "FAILED",
"reasonInfo": {"reason": {"schema": "CODE",
"value": "MS03"
}
}
},
"schemeVerificationReportData": {"schema": "ZA_AVS",
"accountFound": "TRUE",
"accountOpen": "TRUE",
"accountTypeMatch": "TRUE",
"privateIdentificationMatch": "TRUE",
"organisationIdentificationMatch": "NOT_CHECKED",
"trustIdentificationMatch": "NOT_CHECKED",
"initialsMatch": "FALSE",
"nameMatch": "FALSE",
"debitsAllowed": "FALSE",
"creditsAllowed": "TRUE",
"olderThanThreeMonths": "TRUE",
"emailMatch": "NOT_CHECKED",
"mobileMatch": "NOT_CHECKED"
}
}
}

Response samples

application/json

{"detail": "string",
"message": "string",
"schema": "ErrorDetail"
}