Skip to content
Sanmopia Modernization

Get the authenticated branch manager's own branch profile

Switch to Zen Mode
GET
/branch/profile
curl --request GET \
  --url https://example.com/branch/profile \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
membershipFeeOn
string format: date

Calendar date used to resolve the effective membership fee policy

Responses

Section titled “Responses”

200

Section titled “200”

Own branch profile with masked settlement account references

Media typeapplication/json
OwnBranchProfileProjection
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
>= 1 characters <= 100 characters /\S/
legalName
required
One of:
string
>= 1 characters /.*\S.*/
contactEmail
required
One of:
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
/^\+[1-9][0-9]{7,14}$/
address
required
One of:
object
postalCode
required
string
/^[0-9]{5}$/
roadAddress
required
string
>= 1 characters <= 300 characters /\S/
detailAddress
required
One of:
string
>= 1 characters <= 300 characters /\S/
key
additional properties
businessRegistrationReference
required
One of:
string
>= 1 characters /.*\S.*/
profileRevision
required
One of:
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 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 format: date
revisionNumber
required
integer
>= 1
key
additional properties
effectiveMembershipFeePolicy
required
One of:
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 format: date
revisionNumber
required
integer
>= 1
key
additional properties

401

Section titled “401”

Bearer access token is required

403

Section titled “403”

Authenticated actor cannot manage a branch profile

404

Section titled “404”

No own branch profile exists in the authenticated actor scope

422

Section titled “422”

MembershipFeeOn is not a valid calendar date

503

Section titled “503”

Own branch profile authority is unavailable