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

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

post/recipients/{recipientId}/confirm

Request samples

Payload
curl
JavaScript
Node.js

application/json

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

Response samples

application/json

{"accountIdentifier": "55555555",
"bankIdentifier": "395744",
"name": "William Walker",
"displayName": "Electrician",
"type": "business",
"defaultReference": "William Walker",
"currencyCode": "USD",
"intermediaryBankIdentifier": "QBLCCCCV",
"paymentPurposeCode": "BKFE",
"defaultPurpose": "Purpose of the payment",
"subscribedEmails": [{"name": "William Walker",
"email": "test@example.com"
}
],
"address": {"countryCode": "GB",
"address": "123 Fake Street",
"city": "London",
"postcode": "SW1A 1AA"
},
"bankAddress": {"bankName": "Barclays Bank",
"fullBankName": "Barclays Bank Plc",
"address": "1 Churchill Place, London, E14 5HP",
"city": "London",
"postcode": "E14 5HP",
"countryCode": "GB"
},
"id": "string",
"status": "AUTHORISED",
"validation": {"nameMatch": true,
"reason": "string",
"reasonCode": "N000",
"actualName": "William Walker"
},
"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",
"verificationMethod": "phone"
}