Click to Pay API Reference
Click to Pay
Search API Reference
- Merchants and PSPs
- Visa Click to Pay Overview
- Getting Started
- API Fundamentals
- First Steps
- Introduction to Visa Click to Pay API
- Use Cases
- Tutorials and Guides
- Error Codes and Troubleshooting
- Terms of Service and Privacy Notice
- Product Terms
- Glossary
- Request & Response Codes
Secure Remote Commerce
Enable partners to securely add, manage, and use Visa tokenized credentials for digital purchases built on EMV standards.
Identity Lookup v1 - Latest
The Identity Lookup operation uses a provided consumer identity (email address or mobile phone number) to determine whether it is associated with an SRC profile.
Authentication Requirements:
- HTTP Header: x-pay-token - JWT token for authentication
- Query Parameter: apikey - API key issued during onboarding
Request
Request Body schema: application/json
| consumerIdentity required |
object Consumer identity. |
| --- | --- |
| identityType required |
string (Required) Type of consumer identity transmitted or collected. Enum:"EMAIL_ADDRESS" "MOBILE_PHONE_NUMBER" |
| identityValue required |
string [ 1 .. 255 ] characters (Required) Consumer identity value that corresponds to the consumer identity type. Format: String for a valid email address. For a mobile number, use the E.164 format with a maximum length of 15, including the country code. Remove special characters: All spaces, dashes, and parentheses should be removed, and all characters should be numeric. The mobile number must not include "+". Example: user@example.com, 61423123456 |
| identityProvider | string (Optional) Identity provider of the Consumer Identity. The default value is SRC Enum:"SRC" "SRCI" |
| srcClientId required |
string <= 100 characters This is the ID shared by the SRC system with the client that identifies the connecting client, such as SRCi, DCF, or SRC Issuer (SRCPI). If an API key was provided, use the API key as the srcClientId. |
Responses
200
The operation is processed successfully, and the lookup result is included in the response body.
Response Schema: application/json
| consumerPresent1 required |
boolean Indicates whether the Identity Lookup operation was successful. |
| consumerStatus | string Status of the consumer. Must be provided if the specified consumer identity was recognized by the SRC system. Enum:"ACTIVE" "SUSPENDED" "LOCKED" |
| idLookupSessionId | string Session identifier of format UUID, returned by SRC System following an Identity Lookup operation. Can be used in subsequent Initiate Identity Validation operation. Not supported in Visa SRC system. |
| lastUsedCardTimestamp | string Timestamp of the last used card. UTC time in Unix epoch format. |
400
Bad request. See error object for details.
Response Schema: application/json
| message required |
string [ 1 .. 255 ] characters Error message associated with the HTTP status code. |
| reason required |
string [ 1 .. 32 ] characters Error reason associated with the HTTP status code are |
| status required |
string 3 characters HTTP status code to categorize the errors. |
| errorDetail | Array of objects List of error details providing additional information about the error. |
| Array |
| message | string [ 0 .. 32 ] characters Error message. |
| reason | string [ 0 .. 32 ] characters Error reason associated with the error detail |
| source | string [ 0 .. 255 ] characters Name of the source that generated this error. |
| sourceType | string [ 0 .. 255 ] characters Type of the source that generated this error. |
401
Unauthorized. See error object for details, such as authorization token validation failure.
Response Schema: application/json
| message | string [ 0 .. 32 ] characters Error message. |
| reason | string [ 0 .. 32 ] characters Error reason associated with the error detail |
| source | string [ 0 .. 255 ] characters Name of the source that generated this error. |
| sourceType | string [ 0 .. 255 ] characters Type of the source that generated this error. |
403
Forbidden. See error object for details, such as an incorrect SRC DPA ID being used.
Response Schema: application/json
404
Checkout transaction not found.
Response Schema: application/json
500
An internal server error occurred, such as a null pointer exception.
Response Schema: application/json
post/src/v1/identities/lookup
Sandbox server
https://sandbox.api.visa.com/src/v1/identities/lookup
Request samples
- Payload
{"srcClientId": "string",
"consumerIdentity": {"identityType": "EMAIL_ADDRESS",
"identityValue": "string",
"identityProvider": "SRC"
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
500
{"consumerStatus": "ACTIVE",
"consumerPresent1": true,
"idLookupSessionId": "string",
"lastUsedCardTimestamp": "string"
}