{ "openapi": "3.0.4", "info": { "title": "Customer Journey", "description": "The Customer Journey API enables you to determine what point a user is in their credit journey so that you can support them in the next step of their customer journey.", "version": "2.13" }, "paths": { "/customer-journey-details": { "get": { "tags": [ "Customers" ], "summary": "Returns Customer Journey details, using a customer's token to identify them", "operationId": "GetCustomerJourneyDetailsUsingToken", "parameters": [ { "name": "api-version", "in": "header", "description": "Api Version", "schema": { "type": "string", "default": "3.0" } }, { "name": "customer-access-token", "in": "header", "description": "Customer Access Token from Ids", "schema": { "type": "string" } }, { "name": "context-tenant-id", "in": "header", "description": "Context Tenant Id", "required": true, "schema": { "type": "string" }, "examples": { "context-tenant-id": { "value": "f3a5e968b6de4b2380a76afd187cadf3" } } }, { "name": "channel", "in": "header", "description": "Channel of originating request", "schema": { "type": "string" }, "examples": { "channel": { "value": "Mobile" } } }, { "name": "sub", "in": "header", "description": "Subject", "schema": { "type": "string" }, "examples": { "sub": { "value": "john.brown@customer-service.com" } } }, { "name": "obo", "in": "header", "description": "On Behalf Of", "schema": { "type": "string" }, "examples": { "obo": { "value": "mike.smith@customer.com" } } }, { "name": "context-channel", "in": "header", "description": "Deprecated: Channel of originating request", "deprecated": true, "schema": { "type": "string" }, "examples": { "context-channel": { "value": "Mobile" } } }, { "name": "context-sub", "in": "header", "description": "Deprecated: Subject", "deprecated": true, "schema": { "type": "string" }, "examples": { "context-sub": { "value": "john.brown@customer-service.com" } } }, { "name": "context-obo", "in": "header", "description": "Deprecated: On Behalf Of", "deprecated": true, "schema": { "type": "string" }, "examples": { "context-obo": { "value": "mike.smith@customer.com" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomerJourneyResponseV2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerJourneyResponseV2" }, "example": { "customer": { "flags": [ "string" ], "id": "B1DEE421-304B-4FE2-9824-8A84CFCC6D44", "status": "applicant", "isRegisteredForOnline": true, "customerRef": "4VNGUXxihf", "isAccessBlocked": false, "isAccessLocked": false }, "accounts": [ { "accountNumber": "1234987612349876", "status": "open", "flags": [ "overLimit", "pastDue" ], "aer": 0.2994, "accountAer": 0.1234, "paymentDueDate": "2023-10-29", "creditLimits": [ { "type": "account", "amount": { "value": 20.99, "currencyCode": "GBR" }, "updatedAt": "2021-09-30T12:00:00Z", "expiresAt": "2023-10-30T12:00:00Z" } ], "availableCreditLimits": [ { "type": "cash", "amount": { "value": 20.99, "currencyCode": "GBR" } } ], "balances": { "total": { "value": 20.99, "currencyCode": "GBR" }, "pendingCredits": { "value": 20.99, "currencyCode": "GBR" }, "pendingDebits": { "value": 20.99, "currencyCode": "GBR" } }, "dues": { "isDelinquent": true, "delinquencyAge": 1, "arrears": [ { "age": 1, "amount": { "value": 20.99, "currencyCode": "GBR" } } ] }, "activationStatus": "Active", "apr": 0.299, "purchaseSimpleAnnualRate": 0.26481 } ], "applications": [ { "id": "96dcbf9a-6673-4a55-855a-1fa1d20edfc3", "state": "quoteAccept", "subState": "downsell", "creditLimit": 900, "aer": 0.2994, "apr": 0.299, "sar": 0.26481 } ], "kyc": { "evidences": { "property1": { "customerJourneyId": "dbac4cf1-1ba9-402b-a212-844be8150b97", "sessionId": "687cdd1a-617b-421f-8529-d13a3f171f6c", "status": "authenticated", "createdDateTimeUtc": "2022-05-03T21:13:31+01:00", "lockoutEndDateTimeUtc": "2022-05-03T21:13:31+01:00", "passCodeAttempted": true, "passCodeResetsRemaining": 1, "currentPassCodeAttemptsRemaining": 1 }, "property2": { "customerJourneyId": "dbac4cf1-1ba9-402b-a212-844be8150b97", "sessionId": "687cdd1a-617b-421f-8529-d13a3f171f6c", "status": "authenticated", "createdDateTimeUtc": "2022-05-03T21:13:31+01:00", "lockoutEndDateTimeUtc": "2022-05-03T21:13:31+01:00", "passCodeAttempted": true, "passCodeResetsRemaining": 1, "currentPassCodeAttemptsRemaining": 1 } }, "isCompliant": true } } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerJourneyResponseV2" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "examples": { "Invalid Tenant Id header": { "value": { "errors": {}, "type": "newday:generic:error:validation", "title": "context-tenant-id header is required and must be in correct guid format", "status": 400 } } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "examples": { "Invalid Tenant Id header": { "value": { "errors": {}, "type": "newday:generic:error:validation", "title": "context-tenant-id header is required and must be in correct guid format", "status": 400 } } } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "examples": { "Invalid Tenant Id header": { "value": { "errors": {}, "type": "newday:generic:error:validation", "title": "context-tenant-id header is required and must be in correct guid format", "status": 400 } } } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "examples": { "Account not found": { "value": { "type": "newday:generic:error:missing", "title": "Cannot find account", "status": 404 } } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "examples": { "Account not found": { "value": { "type": "newday:generic:error:missing", "title": "Cannot find account", "status": 404 } } } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "examples": { "Account not found": { "value": { "type": "newday:generic:error:missing", "title": "Cannot find account", "status": 404 } } } } } }, "415": { "description": "Unsupported Media Type", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "examples": { "Content-Type header is missing": { "value": { "type": "newday:generic:error:validation", "title": "Content-Type", "status": 415, "detail": "Content-Type header is missing" } }, "Only application/json content-type supported": { "value": { "type": "newday:generic:error:validation", "title": "Content-Type", "status": 415, "detail": "Only application/json content-type supported" } } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "examples": { "Content-Type header is missing": { "value": { "type": "newday:generic:error:validation", "title": "Content-Type", "status": 415, "detail": "Content-Type header is missing" } }, "Only application/json content-type supported": { "value": { "type": "newday:generic:error:validation", "title": "Content-Type", "status": 415, "detail": "Only application/json content-type supported" } } } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "examples": { "Content-Type header is missing": { "value": { "type": "newday:generic:error:validation", "title": "Content-Type", "status": 415, "detail": "Content-Type header is missing" } }, "Only application/json content-type supported": { "value": { "type": "newday:generic:error:validation", "title": "Content-Type", "status": 415, "detail": "Only application/json content-type supported" } } } } } }, "422": { "description": "Unprocessable Content", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "examples": { "Unknown customer status": { "value": { "type": "newday:generic:error:unprocessableentity", "title": "Unknown customer status 'invalid'", "status": 422 } }, "Customer with Customer Status has no accounts": { "value": { "type": "newday:generic:error:unprocessableentity", "title": "Customer with Customer Status has no accounts", "status": 422 } }, "Unexpected Customer AccountId value": { "value": { "type": "newday:generic:error:unprocessableentity", "title": "Unexpected Customer AccountId value", "status": 422 } }, "Customer has no applications": { "value": { "type": "newday:generic:error:unprocessableentity", "title": "Customer has no applications", "status": 422 } }, "Customer has more than one application": { "value": { "type": "newday:generic:error:unprocessableentity", "title": "Customer has more than one application", "status": 422 } } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "examples": { "Unknown customer status": { "value": { "type": "newday:generic:error:unprocessableentity", "title": "Unknown customer status 'invalid'", "status": 422 } }, "Customer with Customer Status has no accounts": { "value": { "type": "newday:generic:error:unprocessableentity", "title": "Customer with Customer Status has no accounts", "status": 422 } }, "Unexpected Customer AccountId value": { "value": { "type": "newday:generic:error:unprocessableentity", "title": "Unexpected Customer AccountId value", "status": 422 } }, "Customer has no applications": { "value": { "type": "newday:generic:error:unprocessableentity", "title": "Customer has no applications", "status": 422 } }, "Customer has more than one application": { "value": { "type": "newday:generic:error:unprocessableentity", "title": "Customer has more than one application", "status": 422 } } } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "examples": { "Unknown customer status": { "value": { "type": "newday:generic:error:unprocessableentity", "title": "Unknown customer status 'invalid'", "status": 422 } }, "Customer with Customer Status has no accounts": { "value": { "type": "newday:generic:error:unprocessableentity", "title": "Customer with Customer Status has no accounts", "status": 422 } }, "Unexpected Customer AccountId value": { "value": { "type": "newday:generic:error:unprocessableentity", "title": "Unexpected Customer AccountId value", "status": 422 } }, "Customer has no applications": { "value": { "type": "newday:generic:error:unprocessableentity", "title": "Customer has no applications", "status": 422 } }, "Customer has more than one application": { "value": { "type": "newday:generic:error:unprocessableentity", "title": "Customer has more than one application", "status": 422 } } } } } }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string", "property1": null, "property2": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "502": { "description": "Bad Gateway", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "examples": { "Bad Gateway": { "value": { "type": "newday:generic:error:badgateway", "title": "An error occurred communicating with a backend service", "status": 502 } } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "examples": { "Bad Gateway": { "value": { "type": "newday:generic:error:badgateway", "title": "An error occurred communicating with a backend service", "status": 502 } } } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "examples": { "Bad Gateway": { "value": { "type": "newday:generic:error:badgateway", "title": "An error occurred communicating with a backend service", "status": 502 } } } } } } }, "x-codeSamples": [ { "lang": "Shell + Curl", "source": "curl --request GET \\\n --url https://dapi.stg-newdaytechnology.net/customerjourney/customer-journey-details \\\n --header 'api-version: SOME_STRING_VALUE' \\\n --header 'channel: Mobile' \\\n --header 'context-channel: Mobile' \\\n --header 'context-obo: mike.smith@customer.com' \\\n --header 'context-sub: john.brown@customer-service.com' \\\n --header 'context-tenant-id: f3a5e968b6de4b2380a76afd187cadf3' \\\n --header 'customer-access-token: SOME_STRING_VALUE' \\\n --header 'obo: mike.smith@customer.com' \\\n --header 'sub: john.brown@customer-service.com'" }, { "lang": "Csharp + Restsharp", "source": "var client = new RestClient(\"https://dapi.stg-newdaytechnology.net/customerjourney/customer-journey-details\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"api-version\", \"SOME_STRING_VALUE\");\nrequest.AddHeader(\"customer-access-token\", \"SOME_STRING_VALUE\");\nrequest.AddHeader(\"context-tenant-id\", \"f3a5e968b6de4b2380a76afd187cadf3\");\nrequest.AddHeader(\"channel\", \"Mobile\");\nrequest.AddHeader(\"sub\", \"john.brown@customer-service.com\");\nrequest.AddHeader(\"obo\", \"mike.smith@customer.com\");\nrequest.AddHeader(\"context-channel\", \"Mobile\");\nrequest.AddHeader(\"context-sub\", \"john.brown@customer-service.com\");\nrequest.AddHeader(\"context-obo\", \"mike.smith@customer.com\");\nIRestResponse response = client.Execute(request);" }, { "lang": "Javascript + Xhr", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://dapi.stg-newdaytechnology.net/customerjourney/customer-journey-details\");\nxhr.setRequestHeader(\"api-version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"customer-access-token\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"context-tenant-id\", \"f3a5e968b6de4b2380a76afd187cadf3\");\nxhr.setRequestHeader(\"channel\", \"Mobile\");\nxhr.setRequestHeader(\"sub\", \"john.brown@customer-service.com\");\nxhr.setRequestHeader(\"obo\", \"mike.smith@customer.com\");\nxhr.setRequestHeader(\"context-channel\", \"Mobile\");\nxhr.setRequestHeader(\"context-sub\", \"john.brown@customer-service.com\");\nxhr.setRequestHeader(\"context-obo\", \"mike.smith@customer.com\");\n\nxhr.send(data);" }, { "lang": "Node + Request", "source": "const request = require('request');\n\nconst options = {\n method: 'GET',\n url: 'https://dapi.stg-newdaytechnology.net/customerjourney/customer-journey-details',\n headers: {\n 'api-version': 'SOME_STRING_VALUE',\n 'customer-access-token': 'SOME_STRING_VALUE',\n 'context-tenant-id': 'f3a5e968b6de4b2380a76afd187cadf3',\n channel: 'Mobile',\n sub: 'john.brown@customer-service.com',\n obo: 'mike.smith@customer.com',\n 'context-channel': 'Mobile',\n 'context-sub': 'john.brown@customer-service.com',\n 'context-obo': 'mike.smith@customer.com'\n }\n};\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n" } ] } }, "/customer-journey-details/{customerRef}": { "get": { "tags": [ "Customers" ], "summary": "Returns Customer Journey details, using a customer-ref to identify the customer", "operationId": "GetCustomerJourneyDetailsUsingCustomerRef", "parameters": [ { "name": "customerRef", "in": "path", "description": "Unique identifier for the customer - required if customerAccessToken not provided in the header", "required": true, "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "Api Version", "schema": { "type": "string", "default": "3.0" } }, { "name": "context-tenant-id", "in": "header", "description": "Context Tenant Id", "required": true, "schema": { "type": "string" }, "examples": { "context-tenant-id": { "value": "f3a5e968b6de4b2380a76afd187cadf3" } } }, { "name": "channel", "in": "header", "description": "Channel of originating request", "schema": { "type": "string" }, "examples": { "channel": { "value": "Mobile" } } }, { "name": "sub", "in": "header", "description": "Subject", "schema": { "type": "string" }, "examples": { "sub": { "value": "john.brown@customer-service.com" } } }, { "name": "obo", "in": "header", "description": "On Behalf Of", "schema": { "type": "string" }, "examples": { "obo": { "value": "mike.smith@customer.com" } } }, { "name": "context-channel", "in": "header", "description": "Deprecated: Channel of originating request", "deprecated": true, "schema": { "type": "string" }, "examples": { "context-channel": { "value": "Mobile" } } }, { "name": "context-sub", "in": "header", "description": "Deprecated: Subject", "deprecated": true, "schema": { "type": "string" }, "examples": { "context-sub": { "value": "john.brown@customer-service.com" } } }, { "name": "context-obo", "in": "header", "description": "Deprecated: On Behalf Of", "deprecated": true, "schema": { "type": "string" }, "examples": { "context-obo": { "value": "mike.smith@customer.com" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomerJourneyResponseV2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerJourneyResponseV2" }, "example": { "customer": { "flags": [ "string" ], "id": "B1DEE421-304B-4FE2-9824-8A84CFCC6D44", "status": "applicant", "isRegisteredForOnline": true, "customerRef": "4VNGUXxihf", "isAccessBlocked": false, "isAccessLocked": false }, "accounts": [ { "accountNumber": "1234987612349876", "status": "open", "flags": [ "overLimit", "pastDue" ], "aer": 0.2994, "accountAer": 0.1234, "paymentDueDate": "2023-10-29", "creditLimits": [ { "type": "account", "amount": { "value": 20.99, "currencyCode": "GBR" }, "updatedAt": "2021-09-30T12:00:00Z", "expiresAt": "2023-10-30T12:00:00Z" } ], "availableCreditLimits": [ { "type": "cash", "amount": { "value": 20.99, "currencyCode": "GBR" } } ], "balances": { "total": { "value": 20.99, "currencyCode": "GBR" }, "pendingCredits": { "value": 20.99, "currencyCode": "GBR" }, "pendingDebits": { "value": 20.99, "currencyCode": "GBR" } }, "dues": { "isDelinquent": true, "delinquencyAge": 1, "arrears": [ { "age": 1, "amount": { "value": 20.99, "currencyCode": "GBR" } } ] }, "activationStatus": "Active", "apr": 0.299, "purchaseSimpleAnnualRate": 0.26481 } ], "applications": [ { "id": "96dcbf9a-6673-4a55-855a-1fa1d20edfc3", "state": "quoteAccept", "subState": "downsell", "creditLimit": 900, "aer": 0.2994, "apr": 0.299, "sar": 0.26481 } ], "kyc": { "evidences": { "property1": { "customerJourneyId": "dbac4cf1-1ba9-402b-a212-844be8150b97", "sessionId": "687cdd1a-617b-421f-8529-d13a3f171f6c", "status": "authenticated", "createdDateTimeUtc": "2022-05-03T21:13:31+01:00", "lockoutEndDateTimeUtc": "2022-05-03T21:13:31+01:00", "passCodeAttempted": true, "passCodeResetsRemaining": 1, "currentPassCodeAttemptsRemaining": 1 }, "property2": { "customerJourneyId": "dbac4cf1-1ba9-402b-a212-844be8150b97", "sessionId": "687cdd1a-617b-421f-8529-d13a3f171f6c", "status": "authenticated", "createdDateTimeUtc": "2022-05-03T21:13:31+01:00", "lockoutEndDateTimeUtc": "2022-05-03T21:13:31+01:00", "passCodeAttempted": true, "passCodeResetsRemaining": 1, "currentPassCodeAttemptsRemaining": 1 } }, "isCompliant": true } } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerJourneyResponseV2" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "examples": { "Invalid Tenant Id header": { "value": { "errors": {}, "type": "newday:generic:error:validation", "title": "context-tenant-id header is required and must be in correct guid format", "status": 400 } } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "examples": { "Invalid Tenant Id header": { "value": { "errors": {}, "type": "newday:generic:error:validation", "title": "context-tenant-id header is required and must be in correct guid format", "status": 400 } } } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "examples": { "Invalid Tenant Id header": { "value": { "errors": {}, "type": "newday:generic:error:validation", "title": "context-tenant-id header is required and must be in correct guid format", "status": 400 } } } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "examples": { "Account not found": { "value": { "type": "newday:generic:error:missing", "title": "Cannot find account", "status": 404 } }, "Customer not found": { "value": { "type": "newday:generic:error:missing", "title": "Customer not found", "status": 404 } } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "examples": { "Account not found": { "value": { "type": "newday:generic:error:missing", "title": "Cannot find account", "status": 404 } }, "Customer not found": { "value": { "type": "newday:generic:error:missing", "title": "Customer not found", "status": 404 } } } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "examples": { "Account not found": { "value": { "type": "newday:generic:error:missing", "title": "Cannot find account", "status": 404 } }, "Customer not found": { "value": { "type": "newday:generic:error:missing", "title": "Customer not found", "status": 404 } } } } } }, "415": { "description": "Unsupported Media Type", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "examples": { "Content-Type header is missing": { "value": { "type": "newday:generic:error:validation", "title": "Content-Type", "status": 415, "detail": "Content-Type header is missing" } }, "Only application/json content-type supported": { "value": { "type": "newday:generic:error:validation", "title": "Content-Type", "status": 415, "detail": "Only application/json content-type supported" } } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "examples": { "Content-Type header is missing": { "value": { "type": "newday:generic:error:validation", "title": "Content-Type", "status": 415, "detail": "Content-Type header is missing" } }, "Only application/json content-type supported": { "value": { "type": "newday:generic:error:validation", "title": "Content-Type", "status": 415, "detail": "Only application/json content-type supported" } } } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "examples": { "Content-Type header is missing": { "value": { "type": "newday:generic:error:validation", "title": "Content-Type", "status": 415, "detail": "Content-Type header is missing" } }, "Only application/json content-type supported": { "value": { "type": "newday:generic:error:validation", "title": "Content-Type", "status": 415, "detail": "Only application/json content-type supported" } } } } } }, "422": { "description": "Unprocessable Content", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "examples": { "CustomerSearch result": { "value": { "type": "newday:generic:error:unprocessableentity", "title": "Expected CustomerSearch to return one result but received 2", "status": 422 } }, "Unknown customer status": { "value": { "type": "newday:generic:error:unprocessableentity", "title": "Unknown customer status 'invalid'", "status": 422 } }, "Customer with Customer Status has no accounts": { "value": { "type": "newday:generic:error:unprocessableentity", "title": "Customer with Customer Status has no accounts", "status": 422 } }, "Unexpected Customer AccountId value": { "value": { "type": "newday:generic:error:unprocessableentity", "title": "Unexpected Customer AccountId value", "status": 422 } }, "Customer has no applications": { "value": { "type": "newday:generic:error:unprocessableentity", "title": "Customer has no applications", "status": 422 } }, "Customer has more than one application": { "value": { "type": "newday:generic:error:unprocessableentity", "title": "Customer has more than one application", "status": 422 } } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "examples": { "CustomerSearch result": { "value": { "type": "newday:generic:error:unprocessableentity", "title": "Expected CustomerSearch to return one result but received 2", "status": 422 } }, "Unknown customer status": { "value": { "type": "newday:generic:error:unprocessableentity", "title": "Unknown customer status 'invalid'", "status": 422 } }, "Customer with Customer Status has no accounts": { "value": { "type": "newday:generic:error:unprocessableentity", "title": "Customer with Customer Status has no accounts", "status": 422 } }, "Unexpected Customer AccountId value": { "value": { "type": "newday:generic:error:unprocessableentity", "title": "Unexpected Customer AccountId value", "status": 422 } }, "Customer has no applications": { "value": { "type": "newday:generic:error:unprocessableentity", "title": "Customer has no applications", "status": 422 } }, "Customer has more than one application": { "value": { "type": "newday:generic:error:unprocessableentity", "title": "Customer has more than one application", "status": 422 } } } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "examples": { "CustomerSearch result": { "value": { "type": "newday:generic:error:unprocessableentity", "title": "Expected CustomerSearch to return one result but received 2", "status": 422 } }, "Unknown customer status": { "value": { "type": "newday:generic:error:unprocessableentity", "title": "Unknown customer status 'invalid'", "status": 422 } }, "Customer with Customer Status has no accounts": { "value": { "type": "newday:generic:error:unprocessableentity", "title": "Customer with Customer Status has no accounts", "status": 422 } }, "Unexpected Customer AccountId value": { "value": { "type": "newday:generic:error:unprocessableentity", "title": "Unexpected Customer AccountId value", "status": 422 } }, "Customer has no applications": { "value": { "type": "newday:generic:error:unprocessableentity", "title": "Customer has no applications", "status": 422 } }, "Customer has more than one application": { "value": { "type": "newday:generic:error:unprocessableentity", "title": "Customer has more than one application", "status": 422 } } } } } }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string", "property1": null, "property2": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "502": { "description": "Bad Gateway", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "examples": { "Bad Gateway": { "value": { "type": "newday:generic:error:badgateway", "title": "An error occurred communicating with a backend service", "status": 502 } } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "examples": { "Bad Gateway": { "value": { "type": "newday:generic:error:badgateway", "title": "An error occurred communicating with a backend service", "status": 502 } } } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "examples": { "Bad Gateway": { "value": { "type": "newday:generic:error:badgateway", "title": "An error occurred communicating with a backend service", "status": 502 } } } } } } }, "x-codeSamples": [ { "lang": "Shell + Curl", "source": "curl --request GET \\\n --url https://dapi.stg-newdaytechnology.net/customerjourney/customer-journey-details/%7BcustomerRef%7D \\\n --header 'api-version: SOME_STRING_VALUE' \\\n --header 'channel: Mobile' \\\n --header 'context-channel: Mobile' \\\n --header 'context-obo: mike.smith@customer.com' \\\n --header 'context-sub: john.brown@customer-service.com' \\\n --header 'context-tenant-id: f3a5e968b6de4b2380a76afd187cadf3' \\\n --header 'obo: mike.smith@customer.com' \\\n --header 'sub: john.brown@customer-service.com'" }, { "lang": "Csharp + Restsharp", "source": "var client = new RestClient(\"https://dapi.stg-newdaytechnology.net/customerjourney/customer-journey-details/%7BcustomerRef%7D\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"api-version\", \"SOME_STRING_VALUE\");\nrequest.AddHeader(\"context-tenant-id\", \"f3a5e968b6de4b2380a76afd187cadf3\");\nrequest.AddHeader(\"channel\", \"Mobile\");\nrequest.AddHeader(\"sub\", \"john.brown@customer-service.com\");\nrequest.AddHeader(\"obo\", \"mike.smith@customer.com\");\nrequest.AddHeader(\"context-channel\", \"Mobile\");\nrequest.AddHeader(\"context-sub\", \"john.brown@customer-service.com\");\nrequest.AddHeader(\"context-obo\", \"mike.smith@customer.com\");\nIRestResponse response = client.Execute(request);" }, { "lang": "Javascript + Xhr", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://dapi.stg-newdaytechnology.net/customerjourney/customer-journey-details/%7BcustomerRef%7D\");\nxhr.setRequestHeader(\"api-version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"context-tenant-id\", \"f3a5e968b6de4b2380a76afd187cadf3\");\nxhr.setRequestHeader(\"channel\", \"Mobile\");\nxhr.setRequestHeader(\"sub\", \"john.brown@customer-service.com\");\nxhr.setRequestHeader(\"obo\", \"mike.smith@customer.com\");\nxhr.setRequestHeader(\"context-channel\", \"Mobile\");\nxhr.setRequestHeader(\"context-sub\", \"john.brown@customer-service.com\");\nxhr.setRequestHeader(\"context-obo\", \"mike.smith@customer.com\");\n\nxhr.send(data);" }, { "lang": "Node + Request", "source": "const request = require('request');\n\nconst options = {\n method: 'GET',\n url: 'https://dapi.stg-newdaytechnology.net/customerjourney/customer-journey-details/%7BcustomerRef%7D',\n headers: {\n 'api-version': 'SOME_STRING_VALUE',\n 'context-tenant-id': 'f3a5e968b6de4b2380a76afd187cadf3',\n channel: 'Mobile',\n sub: 'john.brown@customer-service.com',\n obo: 'mike.smith@customer.com',\n 'context-channel': 'Mobile',\n 'context-sub': 'john.brown@customer-service.com',\n 'context-obo': 'mike.smith@customer.com'\n }\n};\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n" } ] } } }, "components": { "schemas": { "AccountV2": { "type": "object", "properties": { "accountNumber": { "type": "string", "description": "Account Number.", "nullable": true, "example": "1234987612349876" }, "status": { "type": "string", "description": "Account Status (open, chargeOff, closed, fraud, accountClosedPayDown, transferred).", "nullable": true, "example": "open" }, "flags": { "type": "array", "items": { "type": "string" }, "description": "Enumerated list of additional indicators (overLimit, pastDue, debtSold, authorisationBlocked).", "nullable": true, "example": [ "overLimit", "pastDue" ] }, "aer": { "type": "number", "description": "Annual Effective Rate on the account for instalment spend.", "format": "double", "nullable": true, "example": 0.2994 }, "accountAer": { "type": "number", "description": "Annual Effective Rate on the account for retail spend.", "format": "double", "nullable": true, "example": 0.1234 }, "paymentDueDate": { "type": "string", "description": "Due Date for the previous billing period, this may be null until account goes through a billing cycle.", "format": "date", "nullable": true, "example": "2023-10-29" }, "creditLimits": { "type": "array", "items": { "$ref": "#/components/schemas/CreditLimit" }, "description": "Collection of defined credit limits.", "nullable": true }, "availableCreditLimits": { "type": "array", "items": { "$ref": "#/components/schemas/AvailableCreditLimit" }, "description": "Collection of available credit limits.", "nullable": true }, "balances": { "allOf": [ { "$ref": "#/components/schemas/Balances" } ], "description": "Balance details including any pending debit or credit movements.", "nullable": true }, "dues": { "allOf": [ { "$ref": "#/components/schemas/Dues" } ], "description": "Account Dues information.", "nullable": true }, "activationStatus": { "type": "string", "description": "Indicates whether any instrument on the account has been activated. Possible values are Active, or Inactive.", "nullable": true, "example": "Active" }, "apr": { "type": "number", "description": "Annual Percentage Rate on the account based on when the system last recalculated.", "format": "double", "nullable": true, "example": 0.299 }, "purchaseSimpleAnnualRate": { "type": "number", "description": "Simple annual interest rate for purchases.", "format": "double", "nullable": true, "example": 0.26481 } }, "additionalProperties": false }, "Amount": { "type": "object", "properties": { "value": { "type": "number", "description": "Amount Value.", "format": "double", "example": 20.99 }, "currencyCode": { "type": "string", "description": "Currency code of the value - ISO 4217 alpha-3 format.", "nullable": true, "example": "GBR" } }, "additionalProperties": false, "description": "Amount object." }, "Application": { "type": "object", "properties": { "id": { "type": "string", "description": "Application Identifier (GUID).", "nullable": true, "example": "96dcbf9a-6673-4a55-855a-1fa1d20edfc3" }, "state": { "type": "string", "description": "Status of the application.", "nullable": true, "example": "quoteAccept" }, "subState": { "type": "string", "description": "Further details providing granular view of the state.", "nullable": true, "example": "downsell" }, "creditLimit": { "type": "number", "description": "The credit limit associated with the application.", "format": "double", "nullable": true, "example": 900 }, "aer": { "type": "number", "description": "The annual equivalent rate for the product.", "format": "double", "nullable": true, "example": 0.2994 }, "apr": { "type": "number", "description": "The annual percentage rate for the product.", "format": "double", "nullable": true, "example": 0.299 }, "sar": { "type": "number", "description": "The simple annual rate for the product.", "format": "double", "nullable": true, "example": 0.26481 } }, "additionalProperties": false, "description": "Application details" }, "Arrears": { "type": "object", "properties": { "age": { "type": "integer", "description": "Indicator showing how many cycles in arrears the balance is.", "format": "int32", "example": 1 }, "amount": { "allOf": [ { "$ref": "#/components/schemas/Amount" } ], "description": "Amount in arrears for given account age.", "nullable": true } }, "additionalProperties": false, "description": "Detailed breakdown of arrears information on the account." }, "AvailableCreditLimit": { "type": "object", "properties": { "type": { "type": "string", "description": "Credit Limit type (account, cash).", "nullable": true, "example": "cash" }, "amount": { "allOf": [ { "$ref": "#/components/schemas/Amount" } ], "description": "Signed amount value of the available credit limit for given type with overlimit , based on approved transactions, shown as negative values.", "nullable": true } }, "additionalProperties": false, "description": "Available Credit Limit object." }, "Balances": { "type": "object", "properties": { "total": { "allOf": [ { "$ref": "#/components/schemas/Amount" } ], "description": "Total Signed balance amount value at account level.", "nullable": true }, "pendingCredits": { "allOf": [ { "$ref": "#/components/schemas/Amount" } ], "description": "Pending signed credit balance amount value at account level.", "nullable": true }, "pendingDebits": { "allOf": [ { "$ref": "#/components/schemas/Amount" } ], "description": "Pending signed debit balance amount value at account level.", "nullable": true } }, "additionalProperties": false, "description": "Balances object." }, "CreditLimit": { "type": "object", "properties": { "type": { "type": "string", "description": "Credit Limit type (account, cash).", "nullable": true, "example": "account" }, "amount": { "allOf": [ { "$ref": "#/components/schemas/Amount" } ], "description": "Absolute amount value of the credit limit for given type.", "nullable": true }, "updatedAt": { "type": "string", "description": "The date when defined credit limit was last updated (ISO 8601 format).", "format": "date-time", "nullable": true, "example": "2021-09-30T12:00:00Z" }, "expiresAt": { "type": "string", "description": "Date when the temporary limit expires (ISO 8601 format).", "format": "date-time", "nullable": true, "example": "2023-10-30T12:00:00Z" } }, "additionalProperties": false, "description": "Credit Limit object." }, "CustomerJourneyResponseV2": { "type": "object", "properties": { "customer": { "allOf": [ { "$ref": "#/components/schemas/CustomerV2" } ], "description": "Customer status details.", "nullable": true }, "accounts": { "type": "array", "items": { "$ref": "#/components/schemas/AccountV2" }, "description": "Details of the account.", "nullable": true }, "applications": { "type": "array", "items": { "$ref": "#/components/schemas/Application" }, "description": "Application details.", "nullable": true }, "kyc": { "allOf": [ { "$ref": "#/components/schemas/Kyc" } ], "description": "KYC details relating to the applicant.", "nullable": true } }, "additionalProperties": false, "description": "Customer object." }, "CustomerV2": { "type": "object", "properties": { "flags": { "type": "array", "items": { "type": "string" }, "description": "Customer Flags", "nullable": true }, "id": { "type": "string", "description": "Internal Unique identifier for the customer.", "nullable": true, "example": "B1DEE421-304B-4FE2-9824-8A84CFCC6D44" }, "status": { "type": "string", "description": "Indicates status value as (applicant, customer).", "nullable": true, "example": "applicant" }, "isRegisteredForOnline": { "type": "boolean", "description": "Indicates whether the customer is registered for online services (Web, Mobile App etc.).", "example": true }, "customerRef": { "type": "string", "description": "External Merchant identifier for the customer.", "nullable": true, "example": "4VNGUXxihf" }, "isAccessBlocked": { "type": "boolean", "description": "Indicates if the customer online account access is Blocked by System.", "nullable": true, "example": false }, "isAccessLocked": { "type": "boolean", "description": "Indicates if the customer online account access is Locked due to activity by user.", "nullable": true, "example": false } }, "additionalProperties": false, "description": "Customer status details." }, "Dues": { "type": "object", "properties": { "isDelinquent": { "type": "boolean", "description": "Indicates if the account is now under delinquency.", "example": true }, "delinquencyAge": { "type": "integer", "description": "Delinquency level of the account.", "format": "int32", "nullable": true, "example": 1 }, "arrears": { "type": "array", "items": { "$ref": "#/components/schemas/Arrears" }, "description": "Detailed breakdown of arrears information on the account.", "nullable": true } }, "additionalProperties": false, "description": "Account Dues information." }, "Evidence": { "type": "object", "properties": { "customerJourneyId": { "type": "string", "description": "Associated customer journey ID with the session.", "nullable": true, "example": "dbac4cf1-1ba9-402b-a212-844be8150b97" }, "sessionId": { "type": "string", "description": "Latest session ID associated with the status.", "nullable": true, "example": "687cdd1a-617b-421f-8529-d13a3f171f6c" }, "status": { "type": "string", "description": "initiated, failed, authenticated.", "nullable": true, "example": "authenticated" }, "createdDateTimeUtc": { "type": "string", "description": "Creation Date time value.", "format": "date-time", "example": "2022-05-03T21:13:31+01:00" }, "lockoutEndDateTimeUtc": { "type": "string", "description": "Lockout End Date time value.", "format": "date-time", "example": "2022-05-03T21:13:31+01:00" }, "passCodeAttempted": { "type": "boolean", "description": "Indicates whether the user has ever attempted to validate.", "example": true }, "passCodeResetsRemaining": { "type": "integer", "description": "Number of pennies that can still be sent to the user.", "format": "int32", "example": 1 }, "currentPassCodeAttemptsRemaining": { "type": "integer", "description": "Number of codes that can still be submitted by the user.", "format": "int32", "example": 1 } }, "additionalProperties": false, "description": "An object containing the OtpPhoneEvidence and OtpBankAccountEvidence." }, "HealthCheckResponse": { "type": "object", "properties": { "status": { "type": "string", "nullable": true }, "totalDuration": { "type": "string", "format": "date-span" }, "includedChecks": { "type": "array", "items": { "type": "string" }, "nullable": true }, "checkStatuses": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "failedChecks": { "type": "array", "items": { "type": "string" }, "nullable": true }, "serviceName": { "type": "string", "nullable": true }, "slotName": { "type": "string", "nullable": true }, "hostName": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true }, "configName": { "type": "string", "nullable": true }, "serviceVersion": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Kyc": { "type": "object", "properties": { "evidences": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Evidence" }, "nullable": true }, "isCompliant": { "type": "boolean", "description": "Identifies whether KYC has passed according to SCA guidelines: primarily OTP and penny drop successful in the same session ID.", "example": true } }, "additionalProperties": false, "description": "KYC Flags relating to the applicant" }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": {} }, "ValidationProblemDetails": { "type": "object", "properties": { "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": {} } } }, "tags": [ { "name": "Customers" }, { "name": "HealthCheck" } ], "x-pub-settings": { "pub-ready": true, "tags": [ "Customer & Profile", "Spend & Instrument" ], "team": "", "commitDate": 1783334019000 }, "servers": [ { "url": "https://dapi.stg-newdaytechnology.net/customerjourney", "description": "NDT Staging" }, { "url": "https://api.uat-newdaycards.com/customerjourney", "description": "NDC Staging" }, { "url": "https://dapi.newdaytechnology.net/customerjourney", "description": "NDT Production" }, { "url": "https://api.newdaycards.com/customerjourney", "description": "NDC Production" } ] }