Contact Management

This document describes the end-to-end flow for creating, listing, retrieving, and deleting Contacts.

---

Get Contacts per Customer

List with filters
GET /contacts/customers/{customerId}/contacts
See: Get Contacts List

Get by ID
GET /contacts/customers/{customerId}/contacts/{contactId}
See: Get a Contact

---

Create a Contact

1) Initiate Contact Creation

POST /contacts/customers/{customerId}/contacts/initiate
See: Post Initiate Contact Creation

Guidelines:

• Populate recipient details and bankAccountDetails.
• One account = one contact.
  For multiple accounts for the same recipient, create multiple contacts.
• Provide account identification per currency:
  • GBP: accountNumber and sortCode
  • EUR: either accountNumber (wallet number if internal DD) OR [iban + swiftCode ]
  • USD: either accountNumber (wallet number if internal DD) OR [iban + swiftCode ]
• For country codes lookup, use GET /dictionaries/countries (2-letter code).

Request example

{
  "customerId": "decaed83-29a6-4d0f-81ff-25968c32f045",
  "type": "IBAN",
  "currency": "EUR",
  "accountHolderName": "Test Surname",
  "details": {
    "legalType": "PRIVATE",
    "accountNumber": "9876543211122",
    "sortCode": "568765",
    "swiftCode": "",
    "iban": "",
    "address": {
      "countryCode": "DZ",
      "state": "",
      "city": "Best",
      "street": "Ferra",
      "building": "2",
      "postCode": "165po"
    }
  }
}

CoP (Confirmation of Payee) for GBP

For GBP payments, responses may include CoP fields:

• If "copResponseCode": "match" (i.e. account with exact name and type found) --> immediately proceed to the next step.
• For any other code (including AC01 - account not found), you can still create contact, but we require you to log user consent explicitly.
• Non-empty "copNameMatch" outputs the correct account name for the case when provided name was similar, but not completely correct (as determined by the account-holding bank).
• To get all possible response codes, call GET /dictionaries/countries
  See: Get COP Codes

2) Finalize Contact Creation

POST /contacts/customers/{customerId}/contacts/confirmation/finalize
See: Post Finalize Contact Creation

---

Delete a Contact

DELETE /contacts/customers/{customerId}/contacts/{contactId}
See: Delete a Contact

---