Search
K
instruction v1

UpdateInstructionAddressDto

object
namestring

Building name

>= 0 characters<= 50 characters

Example:1 The House

numberstring

House/building number

>= 0 characters<= 4 characters

Example:123a

flatstring

Flat/apartment number

>= 0 characters<= 30 characters

Example:Flat 32

streetstring

Street name

>= 0 characters<= 60 characters

Example:Huddersfield

townstring

Town/city

>= 0 characters<= 30 characters

Example:West Yorkshire

countystring

County name (required for OCE verification)

Example:Greater London

postcodestring

Match pattern:^(([Gg][Ii][Rr] 0[Aa]{2})|((([A-Za-z][0-9]{1,2})|(([A-Za-z][A-Ha-hJ-Yj-y][0-9]{1,2})|(([A-Za-z][0-9][A-Za-z])|([A-Za-z][A-Ha-hJ-Yj-y][0-9][A-Za-z]?))))\s[0-9][A-Za-z]{2}))$

>= 6 characters<= 8 characters

Example:M16 0RA

Example

UpdateAddress

object
flatstring

Flat/apartment number

namestring

Building name

numberstring

House/building number

streetstring

Street name

townstring

Town/city

postcodestring

Match pattern:^(([Gg][Ii][Rr] 0[Aa]{2})|((([A-Za-z][0-9]{1,2})|(([A-Za-z][A-Ha-hJ-Yj-y][0-9]{1,2})|(([A-Za-z][0-9][A-Za-z])|([A-Za-z][A-Ha-hJ-Yj-y][0-9][A-Za-z]?))))\s[0-9][A-Za-z]{2}))$

>= 6 characters<= 8 characters

Example:M16 0RA

Example

CancelInstructionRequest

object
cancellationReasonstringrequired

Reason for cancelling the instruction.

Allowed values:
[OTHER]

Match pattern:^(OTHER)$

Example:OTHER

cancellationNotesForOtherstring

Mandatory when cancellationReason “OTHER” is provided

>= 1 characters<= 100 characters

Example:Incorrect details provided

Example

Email

string

Email address

Match pattern:^$|(?:[A-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[A-z0-9](?:[A-z0-9-]*[A-z0-9])?\.)+[A-z0-9](?:[A-z0-9-]*[A-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[A-z0-9-]*[A-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5A\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])

<= 100 characters

Example

ErrorResponse

object
errorsarray[object]
Show Child Parameters
Example