Skip to main content
GET
/
v1
/
crm
/
leads
/
{leadId}
Get a Lead
curl --request GET \
  --url https://api.example.com/v1/crm/leads/{leadId} \
  --header 'Authorization: Bearer <token>'
{
  "clientPath": "<string>",
  "createdAt": "<string>",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dba": "<string>",
  "firstName": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedAt": "<string>",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amexAccountNumber": "<string>",
  "appProcessingEmail": "jsmith@example.com",
  "assignedTo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "underwriterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "averageAmexVolume": 123,
  "averageTicket": 123,
  "bankId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "bankBinId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "businessPhoneNumber": "<string>",
  "cardOnFile": true,
  "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyWebsite": "<string>",
  "customerServiceEmail": "jsmith@example.com",
  "customReturnPolicy": "<string>",
  "dateEstablished": "<string>",
  "dateSigned": "<string>",
  "yearsInBusiness": 4503599627370495,
  "email": "<string>",
  "federalTaxId": "<string>",
  "industryTypeId": 123,
  "internet": 123,
  "keyed": 123,
  "lastName": "<string>",
  "legal": "<string>",
  "mcc": "<string>",
  "merchantTypeId": 123,
  "monthlyAmexVolume": 123,
  "monthlyVolume": 123,
  "moto": 123,
  "numberOfSalesAgents": 123,
  "officeContactEmail": "jsmith@example.com",
  "partnerLiability": true,
  "partnerLiabilityPercent": 123,
  "phoneNumber": "<string>",
  "processorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "recruiter": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "relationshipManager": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "retail": 123,
  "businessType": "<string>",
  "goodsAndServices": "<string>",
  "riskCategoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "stateOfIncorporation": "<string>",
  "yearsInPaymentIndustry": 123,
  "nextDayFunding": true,
  "reservePercent": 50,
  "bank": {
    "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,
    "mcc": "<string>",
    "industryTypeId": 123,
    "merchantTypeId": 123,
    "dateEstablished": "<string>",
    "stateOfIncorporation": "<string>",
    "companyWebsite": "<string>",
    "averageTicket": 123,
    "monthlyVolume": 123,
    "internet": 123,
    "keyed": 123,
    "moto": 123,
    "retail": 123,
    "monthlyAmexVolume": 123,
    "averageAmexVolume": 123,
    "amexAccountNumber": "<string>",
    "bankId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "bankBinId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "processorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "riskCategoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customReturnPolicy": "<string>",
    "nextDayFunding": true,
    "reservePercent": 50,
    "businessType": "<string>",
    "goodsAndServices": "<string>",
    "yearsInBusiness": 4503599627370495
  },
  "processor": {
    "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,
    "mcc": "<string>",
    "industryTypeId": 123,
    "merchantTypeId": 123,
    "dateEstablished": "<string>",
    "stateOfIncorporation": "<string>",
    "companyWebsite": "<string>",
    "averageTicket": 123,
    "monthlyVolume": 123,
    "internet": 123,
    "keyed": 123,
    "moto": 123,
    "retail": 123,
    "monthlyAmexVolume": 123,
    "averageAmexVolume": 123,
    "amexAccountNumber": "<string>",
    "bankId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "bankBinId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "processorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "riskCategoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customReturnPolicy": "<string>",
    "nextDayFunding": true,
    "reservePercent": 50,
    "businessType": "<string>",
    "goodsAndServices": "<string>",
    "yearsInBusiness": 4503599627370495
  }
}

Authorizations

​
Authorization
string
header
required

Enter token in following format: Bearer

Path Parameters

​
leadId
string
required

Response

The lead record corresponding to the primary identifier.

​
clientPath
string
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)$
​
dba
string
required
Maximum string length: 80
​
firstName
string
required
Maximum string length: 80
​
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)$
​
type
enum<string>
required
Available options:
partner,
merchant
​
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)$
​
accountType
enum<string> | null
Available options:
checking,
savings,
other
​
amexAccountNumber
string | null
Maximum string length: 18
​
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,}$
​
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)$
​
averageAmexVolume
number | null
​
averageTicket
number | null
​
bankId
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)$
​
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)$
​
businessPhoneNumber
string | null
Maximum string length: 32
​
cardOnFile
boolean | null
​
clientId
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)$
​
companyWebsite
​
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,}$
​
customReturnPolicy
string | null
Maximum string length: 100
​
dateEstablished
string | null
​
dateSigned
string | null
​
yearsInBusiness
integer | null
Required range: 0 <= x <= 9007199254740991
​
email
Allowed value: ""
​
federalTaxId
string | null
​
industryTypeId
number | null
​
internet
number | null
​
keyed
number | null
​
lastName
string | null
Maximum string length: 80
​
legal
string | null
Maximum string length: 80
​
liability
enum<string> | null
Available options:
full_liability,
split_liability,
no_liability
​
mcc
string | null
Required string length: 4
​
merchantTypeId
number | null
​
monthlyAmexVolume
number | null
​
monthlyVolume
number | null
​
moto
number | null
​
numberOfEmployees
enum<string> | null
Available options:
1-10,
10-50,
50-100,
100-1000,
1000+
​
numberOfSalesAgents
number | null
​
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,}$
​
ownershipType
enum<string> | null
Available options:
Corporation,
Sole Proprietorship,
Partnership,
Association/Estate/Trust,
Tax Exempt (501C),
International,
Limited Liability (LLC),
Government Agency
​
partnerLiability
boolean | null
​
partnerLiabilityPercent
number | null
​
phoneNumber
string | null
Maximum string length: 32
​
processorId
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)$
​
retail
number | null
​
returnPolicy
enum<string> | null
Available options:
no_questions,
90_days,
90+_days,
all_sales_final,
custom
​
businessType
string | null
Maximum string length: 50
​
goodsAndServices
string | null
​
riskCategoryId
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)$
​
riskProfile
enum<string> | null
Available options:
level_1,
level_2,
level_3,
high_risk
​
stateOfIncorporation
string | null
Required string length: 2
​
status
enum<string> | null
Available options:
data_entry,
lead,
review,
uw_review,
pending,
pending_review,
conditionally_approved,
approved,
closed,
withdrawn,
deleted,
pending_boarding
​
yearsInPaymentIndustry
number | null
​
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
​
bank
object
​
processor
object