Verify account information

This operation is asynchronous. The outcome of the request is delivered by the inboundAccountVerificationReport operation.

The outbound account verification operation can be called to verify whether information held by the caller regarding an account (store of value) is valid.

In the context of payments, this operation is often used prior to making payment, or loading a beneficiary to a banking profile.

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)
schema required	string Value: "AccountVerificationRequest"
required	object (Verification)

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/inbound/account-verification

Request samples

application/json

{"schema": "AccountVerificationRequest",
"messageIdentifiers": {"messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
"creationDateTime": "2022-05-04T03:02:01Z"
},
"transactionIdentifiers": {"endToEndIdentification": "6249118655591098",
"transactionIdentification": "RRN000000001",
"uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa"
},
"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"
}
}
]
}
},
"verification": {"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-823000000",
"emailAddress": "joshua.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"
}
}
}

Response samples

application/json

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