Credit Check Summary
The objective is to provide Distributors with an API endpoint for conducting standard customer credit checks. If the credit check fails, the sale cannot proceed.
This step enables the Solution Provider (SP) to verify the end-customer’s eligibility for credit approval. Credit Check approvals are critical prerequisites before proceeding further. After the process of quote ID validation and Address Validation of Postal Service (AVPS) validation, the actual credit check is performed.
Security
This RESTful service uses a client id enforcement policy as the authentication mechanism. Please work with the Client On-Boarding Team if you do not have the necessary credentials.
Endpoints and Headers
POST API Endpoints
Environment | Base URI |
UAT | https://uat-att-creditcheck-eapi.nprd-gw.cloud.att.com/api/v1/creditCheck/aiab |
Production | https://att-creditcheck-eapi.gw.cloud.att.com/api/v1/creditCheck/aiab |
If you are a Connector, meaning you develop on behalf of multiple Solution Provider accounts to retrieve information for them, you will use the same URL, and ensure that you pass the unique client header per Solution Provider.
API Headers
The following are the parameters that are used for this API:
Field Name | Field Description | Mandatory/Optional |
content-type | application/json. | M |
accept | Specifies the format of the response message body. Structured text message payloads are required to support application/json. No other format is permitted. As they are the only supported format, the accept header is not relevant for those requests. | O |
x-trace-id | This field is used for passing a trace ID between API hops for end-to-end traceability. | M |
x-transaction-id | This field is used for passing a traceable ID to uniquely identify the transactions. | O |
client_id | This field represents the client id. | M |
client_secret | This field represents the client secret. | M |
source | This field should identify the calling system/application. | O |
Scenario 1: Validate Credit Check.
POST
{baseURI}/api/v1/creditCheck/aiab
Request:
{
"spId": "10006",
"subAccountId": "U2V4IE",
"consumerType": "C",
"taxId": "895673478",
"numberOfLines": "1",
"primaryContactEmail": "s.d.narasimhamurthy@accenture.com",
"quoteId": "0Q0dx000002LiOHCA0",
"acceptCreditCheckPolicy": true,
"mobilityCustType": "New",
"accountPhoneNumber": "3432123489",
"legalEntityStreetAddress": "901 Marquette Ave STE 700",
"legalEntityCity": "Minneapolis",
"legalEntityZip": "12345",
"legalEntityCountry": "US",
"legalEntityState": "MN"
}
Response:
{
"status": "Success",
"statusMessage": "Credit check policy has been Accepted",
"creditCheckDetails": {
"AccountId": "0011U00000GgvqdQAB",
"ContextId": "0Q0dx0000026qvdCAA",
"OpportunityId": "006dx00000ENhgw",
"Phone": 8013363330,
"approvedLines": 20,
"billingAccountNumber": "287447749037",
"creditCheckType": "Wireless",
"creditClass": "D",
"creditDate": "2025-12-15",
"creditDestination": "Business",
"creditProcessNumber": "693faec2456ebd5d837f17a1",
"creditResult": "Verified",
"decisionCode": "CA",
"decisionReasonCode": "DA",
"firstName": "MyContactupdate",
"interconnectTransactionId": "clear~CNG-CSI~5d818861-c38f-46f4-9747-33b089cc5d97",
"lastName": "Newupdate",
"marketId": "NBI",
"primaryCountry": "US",
"status": "Open",
"ApprovalLines": "20",
"ApprovalStatus": "Approved",
"NumberOFlines": 1,
"accountName": "Message Envy Layton",
"businessType": "C",
"decisionCodeExpirationDate": "2026-03-15",
"decisionReferenceNumber": 512157930417,
"depositAmount": "0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0",
"error": false,
"primaryCity": "MINNEAPOLIS",
"primaryPostalCode": "55402-3247",
"primaryState": "MN",
"primaryStreet": "901 MARQUETTE AVE STE 700",
"subMarketId": "TON",
"taxId": "L6lpfvAF76dsYbdxghz56dj6s6jFMvy/vbg8q6khQRBmz9eOk5d/qNSER0iBlilG6GxvJbCKDK1ThbqhmgdxCKFWEbIP9qzyPEEnFnUsOJqhfBDJWZpd2/Ux2lZhzo6EEtn+cDdTgyDjWu/6A6AcKFVK23CDjXBY8kdztz1LuItsiYrdMeVRFYY31GDDf9YxolIxdxTYCCTX48FsQOWNQQV3I/c8wSXDN5kGgB8muqbza8t3d7AMczibg6IoPDId/VPUWN7E2cYT/PK5AiapuwebKujHou+FGBqRuo5b3SaeB4VuLuFVOsFioqKJ5r0nDMBORg0p6+cXL3UaydXxBz5bMgnqO7opRruhbH+g4o460UCquzClRQJJQ/LBJu46m+NH12r2csm1IOh9f4iFAyjIo4G75hcQXn93QbfHS8/QQNWC7uQTaa2JEOW2432ihDRyePfrYoSasDSrkK4N7HLn29LaLVURUA7n1zQPO/6QOMiA2KD5mq0ytIeLZoo4cp9WgIzHl55fEUKsGjjUnBjaJk/Njx1ZTJelKUouJwzL3lUeOBgKg8txlJbcumBSZeRlYenWqCfP5hZZ7h45wNHiI8QCAv6J05YQJugnihBKjtPrJFKMCIHUB3k6RvVbN4MM7uLDQQXAxjnb7PkBSPWshBWXM2x6JdzWml4qFTY="
}
}