GET v1/Authentication/ExternalLogin

Login to Creditedge.com externally by providing an API public and private key.

Request Information

Parameters

Name Type Description Additional information
request ExternalLoginRequest Container for the External Login Request input parameters. See parameter details below.

Define this parameter in the request URI.

Parameter Information

Parameter Name: request

Property Type Description
PublicKey String Public key assigned to the user.
Guid String Guid generated once user logs in externally.
Timestamp DateTime Timestamp of when the request is made.
SdkVersion String If the client is using the SDK, the version number will be passed along with the request. This field is optional.

Response Information

Response body formats

application/json, text/json

Sample: 
{
  "success": false,
  "guid": "sample string 2",
  "subscriptionRequired": false,
  "errorOccurred": false,
  "errorMessages": [
    "sample string 1",
    "sample string 2",
    "sample string 3"
  ],
  "request": {
    "publicKey": "sample string 1",
    "guid": "sample string 2",
    "timestamp": "2026-06-05T14:54:07.5630416+00:00",
    "sdkVersion": "sample string 4"
  }
}

application/xml, text/xml

Sample: 
<ExternalLoginResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ErrorMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
    <d2p1:string>sample string 3</d2p1:string>
  </ErrorMessages>
  <ErrorOccurred>false</ErrorOccurred>
  <Request>
    <SdkVersion>sample string 4</SdkVersion>
    <Guid>sample string 2</Guid>
    <PublicKey>sample string 1</PublicKey>
    <Timestamp>2026-06-05T14:54:07.5630416+00:00</Timestamp>
  </Request>
  <Guid>sample string 2</Guid>
  <SubscriptionRequired>false</SubscriptionRequired>
  <Success>false</Success>
</ExternalLoginResponse>