Check client affiliation
POST/v1/partnership/affiliation
Check whether the client identified by email is affiliated with the partner. The response indicates the affiliation result and, when available, returns the client identifier and associated account numbers.
Required scopes:
- read:
partnership.all:readorpartnership.all.
Rate limits:
- This operation counts toward the shared limit of 600 requests per 60 seconds per partner, across all of the partner's API keys and all Partnership API operations.
- An additional limit of 100 requests per 60 seconds applies to this operation. Both limits apply.
Consistency and recovery notes:
- The operation is safe to retry. For a missing or inaccessible resource, verify the identifier and the current resource list before retrying.
Possible errors:
ThrottledServiceTransportErrorErrorAuthenticationFailedPermissionDeniedValidationError
Request
Responses
- 200
- 400
- 401
- 403
- 429
- 500
- 502
- 503
- 504
Successful response.
Bad request or validation error. The response uses either the numeric request-processing error response or the Partnership string-code error response.
Authentication failed. Authentication processing errors use numeric codes; a Partnership operation authentication error uses a string code.
Operation is not permitted for the authenticated API key, partner, or operation scope.
Rate limit exceeded.
Response Headers
Seconds to wait before retrying when the API provides a throttle wait time.
The API or a service required by the operation could not complete the request.
The API could not complete the request to the Partnership service.
A required service is temporarily unavailable or the request deadline was exceeded.
A service required by the Partnership operation could not be reached or timed out.