Skip to main content
GET
/
v1
/
crm
/
partners
/
{partnerId}
Get a Partner
curl --request GET \
  --url https://api.example.com/v1/crm/partners/{partnerId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "clientPath": "<string>",
  "passwordExpirationDays": 123,
  "loginFailureAttempts": 123,
  "loginTimeoutMinutes": 123,
  "tokenTimeoutMinutes": 123,
  "otpValidityMinutes": 123,
  "accountCooldownMinutes": 123,
  "previousPasswordLimit": 123,
  "multifactorEnabled": true,
  "createdAt": "<string>",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedAt": "<string>",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parentClientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dba": "<string>",
  "legal": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "phoneNumber": "<string>",
  "federalTaxId": "<string>",
  "hashedFederalTaxId": "<string>",
  "bankIca": "<string>",
  "bankIsDefault": true,
  "encryptionKeyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dateSigned": "<string>",
  "qaInitiatedAt": "<string>",
  "qaCompletedAt": "<string>",
  "assignedTo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "underwriterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "recruiter": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "relationshipManager": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "businessPhoneNumber": "<string>",
  "officeContactEmail": "jsmith@example.com",
  "appProcessingEmail": "jsmith@example.com",
  "customerServiceEmail": "jsmith@example.com",
  "numberOfSalesAgents": 123,
  "yearsInPaymentIndustry": 123,
  "partnerLiability": true,
  "partnerLiabilityPercent": 123,
  "bankBinId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "nextDayFunding": true,
  "reservePercent": 50,
  "businessType": "<string>",
  "goodsAndServices": "<string>"
}

Authorizations

​
Authorization
string
header
required

Enter token in following format: Bearer

Path Parameters

​
partnerId
string
required

Response

The partner record corresponding to the primary identifier.

​
id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
clientPath
string
required
​
passwordExpirationDays
number
required
​
loginFailureAttempts
number
required
​
loginTimeoutMinutes
number
required
​
tokenTimeoutMinutes
number
required
​
otpValidityMinutes
number
required
​
accountCooldownMinutes
number
required
​
previousPasswordLimit
number
required
​
multifactorEnabled
boolean
required
​
createdAt
string
required
​
createdBy
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
type
enum<string>
required
Available options:
sgpy,
processor,
bank,
partner,
merchant,
agent
​
status
enum<string>
required
Available options:
active,
inactive,
closed
​
updatedAt
string
required
​
updatedBy
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
parentClientId
string<uuid> | null
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
dba
string | null
Maximum string length: 80
​
legal
string | null
Maximum string length: 80
​
firstName
string | null
Maximum string length: 80
​
lastName
string | null
Maximum string length: 80
​
email
Allowed value: ""
​
phoneNumber
string | null
Maximum string length: 32
​
federalTaxId
string | null
​
hashedFederalTaxId
string | null
​
accountType
enum<string> | null
Available options:
checking,
savings,
other
​
bankIca
string | null
​
bankIsDefault
boolean | null
​
encryptionKeyId
string<uuid> | null
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
dateSigned
string | null
​
qaInitiatedAt
string | null
​
qaCompletedAt
string | null
​
assignedTo
string<uuid> | null
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
underwriterId
string<uuid> | null
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
recruiter
string<uuid> | null
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
relationshipManager
string<uuid> | null
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
businessPhoneNumber
string | null
Maximum string length: 32
​
officeContactEmail
string<email> | null
Maximum string length: 256
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
​
appProcessingEmail
string<email> | null
Maximum string length: 256
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
​
customerServiceEmail
string<email> | null
Maximum string length: 256
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
​
numberOfSalesAgents
number | null
​
yearsInPaymentIndustry
number | null
​
partnerLiability
boolean | null
​
partnerLiabilityPercent
number | null
​
bankBinId
string<uuid> | null
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
depositTypeSetting
enum<string> | null
Available options:
gross,
net
​
fundingDelay
enum<string> | null
Available options:
0,
1,
2
​
nextDayFunding
boolean | null
​
minimumDiscountType
enum<string> | null
Available options:
daily,
monthly
​
reservePercent
number | null
Required range: 0 <= x <= 100
​
businessType
string | null
​
goodsAndServices
string | null