Initiate Credit Check AIAB
Version v1
Endpoint
POST
https://att-creditcheck-eapi.gw.cloud.att.com/api/v1/creditCheck/aiab
Copy
Provides credit check functionality for provided account. A credit check is required for IPBB orders.
Header Parameters
- sourcestringThis field should identify the calling system/application.Example: product-papi/product
- x-transaction-idstringThis field is used for passing a traceable ID to uniquely identify the transactions. This field should ALWAYS be used within APIs.Example: 73c427a4-2482-4e64-8cac-ea4ace577871
- client_idstringRequiredExample: 7b404180fbb84b099179a4126a9576ff
- client_secretstringRequiredExample: e241f4aa3eca4b2a8FA67A2FEF5754F8
- x-trace-idstringRequiredThis field is used for passing a trace ID between API hops for end to end traceability. This field should ALWAYS be used within APIs.Example: a49fd114-c14b-11ea-b3de-0242ac130004
Body Parameters
- object
- quoteIdstringRequired
- userEmailstringRequired
- subAccountIdstringRequired
- businessTypestringRequiredEnum: [C, A, T, S, K, P, M]Type of business entity. Allowed values: C (Corporation), A (Association), T (Limited Liability Corp/LLC), S (Sole Proprietor), K (Online Sole Proprietor), P (Partnership/LLP), M (Online Partnership)
- legalEntityCitystringRequired
- primaryLastNamestring
- legalEntityStatestringRequired
- primaryFirstNamestring
- legalEntityZipCodestringRequired
- legalEntityCountrystringRequired
- legalEntityStreetAddressstringRequired
Responses
Success
Body
application/json
- object
- errorCodestringRequired
- bureauNamestringRequired
- noErrorFlagbooleanRequired
- creditClassstringRequired
- creditCheckIdstringRequired
- pastDueAmountstringRequired
- accountBalancestringRequired
- approvalStatusstringRequired
- isRefusedToPaystringRequired
- logErrorMessagestringRequired
- displayErrorPagebooleanRequired
- minimumAmountDuestringRequired
- creditDestinationstringRequired
- approvalStatusNotesstringRequired
- casApplicationNumberRequired
- individualCustomerKeystringRequired
- affiliateAccountNumberstringRequired
- isDebtResolutionPendingbooleanRequired
- unifiedCreditTransactionIdstringRequired
- isUpdatedApplicationRequiredbooleanRequired
- isIdentityVerificationRequiredbooleanRequired