Global.Church Developer Portal
Global.Church API

Onboarding

Endpoint:https://api.global.church

Check user and org claim (GET)

GET
https://api.global.church
/v0/onboarding/check-user

Returns whether the signed-in person has a profile, and its name. Send the person's Home sign-in token in the x-home-id-token header; the gateway verifies it and refuses the request with 401 without a valid one. The person is the token's subject: userId is set from it and any userId sent in the query is ignored.

Check user and org claim (GET) › query Parameters

  • userIdstring

    Set by the gateway from the verified token's subject (the Home's sub). Any value the caller sends is dropped.

Check user and org claim (GET) › Headers

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

  • x-home-id-tokenstring · required

    The signed-in person's sign-in token (the ES256 id_token issued by the Home). The gateway verifies its signature, issuer, audience and expiry, and takes the person from its subject.

Check user and org claim (GET) › Responses

User check result with optional org claim

  • existsboolean · required
  • userIdstring
  • emailstring · email
  • firstNamestring
  • lastNamestring
  • orgUristring
  • orgNamestring
  • orgTypestring

Check if user exists (POST)

POST
https://api.global.church
/v0/onboarding/check-user

Checks whether the signed-in person has a profile. Send the person's Home sign-in token in the x-home-id-token header; the gateway verifies it and refuses the request with 401 without a valid one. The person is the token's subject: userId is set from it and any userId sent in the body is ignored.

Check if user exists (POST) › Headers

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

  • x-home-id-tokenstring · required

    The signed-in person's sign-in token (the ES256 id_token issued by the Home). The gateway verifies its signature, issuer, audience and expiry, and takes the person from its subject.

Check if user exists (POST) › Request Body
optional

  • userIdstring

    Set by the gateway from the verified token's subject (the Home's sub). Any value the caller sends is dropped.

Check if user exists (POST) › Responses

User check result

  • existsboolean · required
  • userIdstring
  • emailstring · email
  • firstNamestring
  • lastNamestring

CORS preflight for check-user

OPTIONS
https://api.global.church
/v0/onboarding/check-user

CORS preflight for check-user › Responses

No content

No data returned
Hex GridProfile