Credit Check
Version v1
Endpoint
POST
Contact DL-APS_API_Services@att.com to get Endpoint details /creditCheck-apex
Copy
This API allows users to conduct customer credit checks.
Header Parameters
- content-typestringRequiredapplication/jsonExample: application/json
- acceptstringSpecifies the format of the response message body. Structured text message payloads are required to support application/json.Example: application/json
- x-trace-idstringRequiredThis field is used for passing a trace ID between API hops for end-to-end traceability.Example: givingXTracing123456
- x-transaction-idstringThis field is used for passing a traceable ID to uniquely identify the transactions.Example: 1234
- client_idstringRequiredThis field represents the client id.
- client_secretstringRequiredThis field represents the client secret.
- sourcestringThis field should identify the calling system/application.
Body Parameters
- object
- quoteIdstringRequiredThis field represents quote id.Example: 0Q0dx000002BpxKCAS
- spIdstringRequiredThis field represents Solution Provider id.Example: A-06399x
Responses
Your request was processed successfully
Body
application/json
- objectRequired
- flowNamestringName of the process flow executed.Example: createCreditCheck
- idstringUnique identifier for the flow execution.Example: 1234
- statusstringOverall status of the flow execution.Example: Success
- statusMessagestringMessage describing the outcome of the flow execution.Example: New credit check record has been created
- creditCheckIdstringUnique identifier for the credit check record.Example: a9Xdx000000VF2nEAG
- creditCheckDetailsobjectThis object contains credit check details given in the request.