Search Customers by email
Used during authentication to lookup customer data based on email address. Customers will be authenticated via OTP before data sharing is authorised.
Rate limited to 10 requests per second per client. See Bring Your Own Data for the surrounding consent flow.
Custom Schema implementers own this endpoint: Fiskil calls it on your resource server during the consent flow, so the contract below is what you build, not what you call.
Match on the exact email address only. Fuzzy matching breaks OTP delivery.
Used during authentication to lookup customer data based on email address. Customers will be authenticated via OTP before data sharing is authorised.
Authorization
bearerAuth The Fiskil Data Provider will include a self-signed JWT as a Bearer token in the Authorization header.
You should verify this JWT using the JWKS URL you can find for your Data Provider instance in the Fiskil
Console. To verify the JWT you must:
- Verify the signature
- Ensure the token has not expired by checking the
expclaim - The
subandissclaims are your data provider subdomain - The
audclaim is the URI of the resource being requested (excluding any query parameters) - The
jtivalue is unique For further detail on security and authentication refer to our Authentication documentation
In: header
Request Body
application/json
email of customer
The email address of the end-user trying to authenticate. The API should return any customers that this end-user is associated with. The user may be the owner of the customer or just an authorized contact. For example, the same email may be associated with an individual customer and a business customer. Both customers should be returned.
Response Body
application/json
curl -X POST "https://example.com/auth/v1/customer/search" \ -H "Content-Type: application/json" \ -d '{ "email": "example@acme-corp.com" }'{ "data": [ { "id": "customerid", "name": "givenName familyName", "phoneNumber": "+6141234567890" } ]}An email with no match returns 200 with an empty result, not a 404.