Update the authenticated branch manager's editable own-profile facts

PATCH

/branch/profile

const url = 'https://example.com/branch/profile';
const options = {
  method: 'PATCH',
  headers: {
    'Idempotency-Key': 'example',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"expectedRevision":1,"displayName":"example","contactEmail":"example","primaryPhoneNumber":"example","address":{"postalCode":"example","roadAddress":"example","detailAddress":"example"},"reason":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://example.com/branch/profile \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --data '{ "expectedRevision": 1, "displayName": "example", "contactEmail": "example", "primaryPhoneNumber": "example", "address": { "postalCode": "example", "roadAddress": "example", "detailAddress": "example" }, "reason": "example" }'

Authorizations

bearerAuth

Parameters

Header Parameters

Idempotency-Key

required

string

>= 1 characters <= 255 characters /^\S(?:.*\S)?$/

Request Body^required

application/json

UpdateOwnBranchProfileRequest

object

expectedRevision

required

integer

displayName

required

string

>= 1 characters <= 100 characters /\S/

contactEmail

required

string

<= 254 characters /^[A-Za-z0-9_+%-]+(?:\.[A-Za-z0-9_+%-]+)*@[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?(?:\.[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?)+$/

primaryPhoneNumber

required

string

/^\+[1-9][0-9]{7,14}$/

address

required

object

postalCode

required

string

/^[0-9]{5}$/

roadAddress

required

string

>= 1 characters <= 300 characters /\S/

detailAddress

required

One of:

string
null

string

>= 1 characters <= 300 characters /\S/

key

additional properties

reason

required

string

>= 1 characters <= 500 characters /\S/

key

additional properties

Responses

200

Exact replay returns the full authoritative profile projection

application/json

object

branchOfficeProfileId

required

string

>= 1 characters /.*\S.*/

currentRevision

required

integer

lifecycleState

required

string

Allowed values: onboarding active suspended closed

lifecycleRevision

required

integer

displayName

required

One of:

string
null

string

>= 1 characters <= 100 characters /\S/

legalName

required

One of:

string
null

string

>= 1 characters /.*\S.*/

contactEmail

required

One of:

string
null

string

<= 254 characters /^[A-Za-z0-9_+%-]+(?:\.[A-Za-z0-9_+%-]+)*@[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?(?:\.[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?)+$/

primaryPhoneNumber

required

One of:

string
null

string

/^\+[1-9][0-9]{7,14}$/

address

required

One of:

object
null

object

postalCode

required

string

/^[0-9]{5}$/

roadAddress

required

string

>= 1 characters <= 300 characters /\S/

detailAddress

required

One of:

string
null

string

>= 1 characters <= 300 characters /\S/

key

additional properties

businessRegistrationReference

required

One of:

string
null

string

>= 1 characters /.*\S.*/

profileRevision

required

One of:

integer
null

integer

>= 1

completeness

required

string

Allowed values: incomplete complete

allowedNextActions

required

Array<string>

unique items

Allowed values: update_profile_facts

settlementAccounts

required

Array<object>

object

settlementAccountId

required

string

>= 1 characters /.*\S.*/

purpose

required

string

Allowed values: statement_remittance branch_deposit membership_fee refund

bankName

required

string

>= 1 characters /.*\S.*/

accountHolder

required

string

>= 1 characters /.*\S.*/

maskedAccountReference

required

/\*/

verificationState

required

string

Allowed values: unverified verification_requested verified rejected expired

effectiveFrom

required

string format: date

effectiveUntil

required

One of:

string
null

string format: date

revisionNumber

required

integer

>= 1

key

additional properties

membershipFeePolicies

required

Array<object>

object

membershipFeePolicyId

required

string

>= 1 characters /.*\S.*/

policyVersion

required

string

>= 1 characters /.*\S.*/

monthlyFeeAmount

required

integer

<= 2147483647

currencyCode

required

string

/^[A-Z]{3}$/

effectiveFrom

required

string format: date

effectiveUntil

required

One of:

string
null

string format: date

revisionNumber

required

integer

>= 1

key

additional properties

effectiveMembershipFeePolicy

required

One of:

object
null

object

membershipFeePolicyId

required

string

>= 1 characters /.*\S.*/

policyVersion

required

string

>= 1 characters /.*\S.*/

monthlyFeeAmount

required

integer

<= 2147483647

currencyCode

required

string

/^[A-Z]{3}$/

effectiveFrom

required

string format: date

effectiveUntil

required

One of:

string
null

string format: date

revisionNumber

required

integer

>= 1

key

additional properties

idempotentReplay

required

boolean

idempotentReplay

201

Editable own-profile facts committed as a new revision

application/json

object

branchOfficeProfileId

required

string

>= 1 characters /.*\S.*/

currentRevision

required

integer

lifecycleState

required

string

Allowed values: onboarding active suspended closed

lifecycleRevision

required

integer

displayName

required

One of:

string
null

string

>= 1 characters <= 100 characters /\S/

legalName

required

One of:

string
null

string

>= 1 characters /.*\S.*/

contactEmail

required

One of:

string
null

string

<= 254 characters /^[A-Za-z0-9_+%-]+(?:\.[A-Za-z0-9_+%-]+)*@[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?(?:\.[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?)+$/

primaryPhoneNumber

required

One of:

string
null

string

/^\+[1-9][0-9]{7,14}$/

address

required

One of:

object
null

object

postalCode

required

string

/^[0-9]{5}$/

roadAddress

required

string

>= 1 characters <= 300 characters /\S/

detailAddress

required

One of:

string
null

string

>= 1 characters <= 300 characters /\S/

key

additional properties

businessRegistrationReference

required

One of:

string
null

string

>= 1 characters /.*\S.*/

profileRevision

required

One of:

integer
null

integer

>= 1

completeness

required

string

Allowed values: incomplete complete

allowedNextActions

required

Array<string>

unique items

Allowed values: update_profile_facts

settlementAccounts

required

Array<object>

object

settlementAccountId

required

string

>= 1 characters /.*\S.*/

purpose

required

string

Allowed values: statement_remittance branch_deposit membership_fee refund

bankName

required

string

>= 1 characters /.*\S.*/

accountHolder

required

string

>= 1 characters /.*\S.*/

maskedAccountReference

required

/\*/

verificationState

required

string

Allowed values: unverified verification_requested verified rejected expired

effectiveFrom

required

string format: date

effectiveUntil

required

One of:

string
null

string format: date

revisionNumber

required

integer

>= 1

key

additional properties

membershipFeePolicies

required

Array<object>

object

membershipFeePolicyId

required

string

>= 1 characters /.*\S.*/

policyVersion

required

string

>= 1 characters /.*\S.*/

monthlyFeeAmount

required

integer

<= 2147483647

currencyCode

required

string

/^[A-Z]{3}$/

effectiveFrom

required

string format: date

effectiveUntil

required

One of:

string
null

string format: date

revisionNumber

required

integer

>= 1

key

additional properties

effectiveMembershipFeePolicy

required

One of:

object
null

object

membershipFeePolicyId

required

string

>= 1 characters /.*\S.*/

policyVersion

required

string

>= 1 characters /.*\S.*/

monthlyFeeAmount

required

integer

<= 2147483647

currencyCode

required

string

/^[A-Z]{3}$/

effectiveFrom

required

string format: date

effectiveUntil

required

One of:

string
null

string format: date

revisionNumber

required

integer

>= 1

key

additional properties

idempotentReplay

required

boolean

idempotentReplay

401

Bearer access token is required

application/json

One of:

object

status

required

Allowed value: 401

code

required

Allowed value: authentication_required

retryable

required

key

additional properties

403

Authenticated actor cannot update an own branch profile

application/json

One of:

object

status

required

Allowed value: 401

code

required

Allowed value: authentication_required

retryable

required

key

additional properties

404

No own branch profile exists in the authenticated actor scope

application/json

One of:

object

status

required

Allowed value: 401

code

required

Allowed value: authentication_required

retryable

required

key

additional properties

409

Expected revision or idempotency authority conflicts with current profile facts

application/json

One of:

object

status

required

Allowed value: 401

code

required

Allowed value: authentication_required

retryable

required

key

additional properties

422

Validation failed; Idempotency-Key errors use idempotencyKey and unknown root fields use request without echoing field names

application/json

One of:

object

status

required

Allowed value: 401

code

required

Allowed value: authentication_required

retryable

required

key

additional properties

503

Own branch profile update authority is unavailable

application/json

One of:

object

status

required

Allowed value: 401

code

required

Allowed value: authentication_required

retryable

required

key

additional properties

Update the authenticated branch manager's editable own-profile facts

Authorizations

Parameters

Header Parameters

Request Bodyrequired

Responses

200

201

401

403

404

409

422

503

Request Body^required