Confirm a recipient

Confirms a new recipient's details.

SecurityCommonAuth

Request

path Parameters

recipientId

required

string

query Parameters

accountId

required

string

The ID of the account to work with.

Example: accountId=F50091

Request Body schema: application/json

Body

verificationMethod required	string Enum: "phone" "sms_otp" "biometrics" "email" "other"
sessionId	string The id of the users MFA session
token	string The MFA token

Responses

201

Created

post/recipients/{recipientId}/confirm

Request samples

Payload
curl
JavaScript
Node.js

application/json

{"verificationMethod": "phone",
"sessionId": "string",
"token": "string"
}

Response samples

application/json

{"id": "8lciyups6",
"accountId": "F50091",
"status": "AUTHORISED",
"accountIdentifier": "55555555",
"bankIdentifier": "395744",
"name": "William Walker",
"displayName": "Electrician",
"type": "business",
"defaultReference": "William Walker",
"currencyCode": "USD",
"verificationMethod": "phone",
"charges": "SHA",
"intermediaryBankIdentifier": "QBLCCCCV",
"paymentPurposeCode": "BKFE",
"paymentNetwork": "SWIFT",
"defaultPurpose": "Purpose of the payment",
"subscribedEmails": [{"name": "William Walker",
"email": "test@example.com"
}
],
"address": {"countryCode": "AD",
"address": "123 Fake Street",
"city": "London",
"postcode": "SW1A 1AA"
},
"validation": {"nameMatch": true,
"reason": "string",
"reasonCode": "N000",
"actualName": "William Walker"
},
"bankAddress": {"bankName": "Brilliant Bank",
"fullBankName": "Brilliant Bank Plc",
"city": "Enfield",
"postcode": "EN1 3JY",
"countryCode": "AD",
"address": "1 High Street"
},
"dateLastPaid": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"archivedAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"updatedBy": "string"
}