Create customer relationship

See customerRelationship object definition for parameter details.

🚧Warning

Use of this endpoint requires approval from Q2 and your bank of record.

Error Codes

Click to expand
CodeMessage (en-US)Notes
1-60000Any "Common Error Code" may occur.See Common Error Codes
60001primaryCustomerId or relatedCustomerId 0 is invalid.
60002Customer id 0 is inactive.
60003Customer id 0 is not in 1 status.
60004Customer id 0 is locked.
60005Customer id 0 is marked as deceased.
61400Program is not authorized to use this endpoint. Please contact your relationship manager for details.
156301RelationshipTypeId is a required field.
156302PrimaryCustomerId and RelatedCustomerId are required.
156303CanOpenAccounts is a required field
156304IsPrimaryContact is a required field
156305IsControlPerson is a required field.
156306IsBeneficialOwner is a required field.
156307This relationship already exists, use Update to make changes
156409Invalid relationshipType '{relationshipType}' for business type '{primaryCustomer.legalEntityType}'
156410Invalid relationshipType '{relationshipType}'
156411RequestingCutomerId {request.requestingCustomerId} must have an active customer relationship to primaryCustomerId {request.primaryCustomerId}
156412RequestingCustomerId {request.RequestingCustomerId} does not have proper permissions.
196027externalAccountAccessType '{request.externalAccountAccessType}' is invalid. Please refer to API documentation for valid types.
Body Params
int32
required
≥ 1
int32
required
≥ 1
string
enum
required
boolean
required
string
enum
required
Allowed:
boolean
required
boolean
required
boolean
required
number
string
length ≤ 100
int32
≥ 1
Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json